Documentation Powered by ReDoc

Unite US API (3)

Download OpenAPI specification:Download

Unite US API.

© 2020 Unite US, Inc. All Rights Reserved.

API: Bootstrap

Returns server-side defined bootstrap configuration options for use with client applications.

Responses

Returns server-side defined service types for use with client applications.

query Parameters
flattened
boolean

Optionally return a flattened list of service types

Responses

API: Status

Checks the status of the Unite US API.

Responses

Checks the status of the Unite US API.

Responses

Address Book Groups

Create a new address book group profile.

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_numbers[phone_number][phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

group[name]
string

The name of the address book group.

group[description]
string

Description of the address book group

group[founded_year]
number

The year the group was founded.

group[status]
string
Enum: "draft" "in_review" "published" "archived"

Status of the address book group

group[primary_contact_name]
string

Primary contact name of the address book group

email_addresses
Array of strings
addresses
Array of strings
phone_numbers[phone_number][is_primary]
boolean

Is this phone number the group's primary group number

phone_numbers[phone_number][phone_type]
string
Enum: "work" "mobile" "fax" "unknown"

Type of phone number.

phone_numbers[phone_number][can_sms]
boolean

Can this phone number receive SMS?

phone_numbers[phone_number][country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

schedule[week]
Array of strings

The hours of operation for the provided day

service_types
Array of strings

The uuids of the service type(s)

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_numbers[phone_number][phone_number]": "string",
  • "group[name]": "string",
  • "group[description]": "string",
  • "group[founded_year]": 0,
  • "group[status]": "draft",
  • "group[primary_contact_name]": "string",
  • "email_addresses":
    [
    ],
  • "addresses":
    [
    ],
  • "phone_numbers[phone_number][is_primary]": true,
  • "phone_numbers[phone_number][phone_type]": "work",
  • "phone_numbers[phone_number][can_sms]": true,
  • "phone_numbers[phone_number][country_code]": "string",
  • "schedule[week]":
    [
    ],
  • "service_types":
    [
    ]
}

Update an address book group profile.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_numbers[phone_number][phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

group[name]
string

The name of the address book group.

group[description]
string

Description of the address book group

group[founded_year]
number

The year the group was founded.

group[status]
string
Enum: "draft" "in_review" "published" "archived"

Status of the address book group

group[primary_contact_name]
string

Primary contact name of the address book group

email_addresses
Array of strings
addresses
Array of strings
phone_numbers[phone_number][is_primary]
boolean

Is this phone number the group's primary group number

phone_numbers[phone_number][phone_type]
string
Enum: "work" "mobile" "fax" "unknown"

Type of phone number.

phone_numbers[phone_number][can_sms]
boolean

Can this phone number receive SMS?

phone_numbers[phone_number][country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

schedule[week]
Array of strings

The hours of operation for the provided day

service_types
Array of strings

The uuids of the service type(s)

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_numbers[phone_number][phone_number]": "string",
  • "group[name]": "string",
  • "group[description]": "string",
  • "group[founded_year]": 0,
  • "group[status]": "draft",
  • "group[primary_contact_name]": "string",
  • "email_addresses":
    [
    ],
  • "addresses":
    [
    ],
  • "phone_numbers[phone_number][is_primary]": true,
  • "phone_numbers[phone_number][phone_type]": "work",
  • "phone_numbers[phone_number][can_sms]": true,
  • "phone_numbers[phone_number][country_code]": "string",
  • "schedule[week]":
    [
    ],
  • "service_types":
    [
    ]
}

Update an address book group profile.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_numbers[phone_number][phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

group[name]
string

The name of the address book group.

group[description]
string

Description of the address book group

group[founded_year]
number

The year the group was founded.

group[status]
string
Enum: "draft" "in_review" "published" "archived"

Status of the address book group

group[primary_contact_name]
string

Primary contact name of the address book group

email_addresses
Array of strings
addresses
Array of strings
phone_numbers[phone_number][is_primary]
boolean

Is this phone number the group's primary group number

phone_numbers[phone_number][phone_type]
string
Enum: "work" "mobile" "fax" "unknown"

Type of phone number.

phone_numbers[phone_number][can_sms]
boolean

Can this phone number receive SMS?

phone_numbers[phone_number][country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

schedule[week]
Array of strings

The hours of operation for the provided day

service_types
Array of strings

The uuids of the service type(s)

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_numbers[phone_number][phone_number]": "string",
  • "group[name]": "string",
  • "group[description]": "string",
  • "group[founded_year]": 0,
  • "group[status]": "draft",
  • "group[primary_contact_name]": "string",
  • "email_addresses":
    [
    ],
  • "addresses":
    [
    ],
  • "phone_numbers[phone_number][is_primary]": true,
  • "phone_numbers[phone_number][phone_type]": "work",
  • "phone_numbers[phone_number][can_sms]": true,
  • "phone_numbers[phone_number][country_code]": "string",
  • "schedule[week]":
    [
    ],
  • "service_types":
    [
    ]
}

All-Time Reports: Actionables Summary

Returns a snapshot of the selected organization or network's actionables.

path Parameters
group_id
required
string

Responses

All-Time Reports: Counts Summary

Returns counts of actionables for the selected organization

path Parameters
group_id
required
string

Responses

Accepts consent and stores captured signature

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
consent[signature_image]
string

Base64 of the signature image

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "consent[signature_image]": "string"
}

Rejects consent request that is found

path Parameters
contact_id
required
string
group_id
required
string

Responses

Assistance Requests: Filter Timeline Events

Returns a list of filtered events.

Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
assistance_request_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
q[filter_names]
string
Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team"

Name of filter to be appliied

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[filter_names]": "client_updates",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string"
}

Assistance Requests: Timeline Events

Returns a list of events for the selected Contact.

Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
assistance_request_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Authentication: Validate Token

Validates the supplied authentication token.

Validates the supplied authentication token to allow a client to determine if the token is valid or not. A 200 OK response will be issued to indicate the token is valid. A 401 UNAUTHORIZED response will be issued to indicate the token is not valid.

Request Body schema:
application/json
application/json
multipart/form-data
access_token
required
string

Bearer token to validate. Should be formatted as 'Bearer TOKEN_VALUE'

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "access_token": "string"
}

Back Office: Duplicate a form and all associations

Duplicate the specified form and return the duplicated form.

path Parameters
form_id
required
string

Responses

Back Office: Duplicate a section and all its children

Duplicate the specified form and return the duplicated form.

path Parameters
id
required
string
form_id
required
string

Responses

Back Office: Forms

Returns a list of forms available.

query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Create a new form for the group.

Create a new group form.

Request Body schema:
application/json
application/json
multipart/form-data
form[name]
string

Name of the form.

form[notes_text]
string

Additional notes or description to help identify the form.

form[is_active]
boolean

Is the form active or inactive.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "form[name]": "string",
  • "form[notes_text]": "string",
  • "form[is_active]": true
}

Returns details of the selected form.

path Parameters
id
required
string

Responses

Update an existing form.

Apply an update to an existing group form.

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
form[name]
string

Name of the form.

form[notes_text]
string

Additional notes or description to help identify the form.

form[is_active]
boolean

Is the form active or inactive.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "form[name]": "string",
  • "form[notes_text]": "string",
  • "form[is_active]": true
}

Update an existing form.

Apply an update to an existing group form.

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
form[name]
string

Name of the form.

form[notes_text]
string

Additional notes or description to help identify the form.

form[is_active]
boolean

Is the form active or inactive.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "form[name]": "string",
  • "form[notes_text]": "string",
  • "form[is_active]": true
}

Back Office: Forms -> Questions

Creates a new question on the selected form.

Create a new question and adds it to the selected form.

path Parameters
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
question[conditional_display][show_or_hide_question_id]
required
string

Identifier of the question to be shown or hide.

question[conditional_display][show_or_hide]
required
string
Enum: "show" "hide"

Show or hide the specified question based on the conditions.

question[display_order]
required
number

The position of the question within the question list display. If within a section, the order is scoped.

question[label_text]
required
string

The label text to be displayed for the question.

question[section_id]
string

Identifier of the form section this question belongs to

question[placeholder_text]
string

Placeholder text to be displayed within the input, if supported by the browser.

question[help_text]
string

Help text to be displayed with the question.

question[help_text_position]
string
Enum: "before_input" "after_input"

Where to position the help text, if help text is provided.

question[is_required]
boolean

Is this question required to be completed?

question[min_selections]
number

If the question is a selection-based question (drop-down, checkbox list, etc.), what is the minimum number of selections that must be made.

question[max_selections]
number

If the question is a selection-based question (drop-down, checkbox list, etc.), what is the maximum number of selections that may be made.

question[input_options]
Array of strings
question[conditional_display][and_conditions]
Array of strings
question[conditional_display][or_conditions]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "question[conditional_display][show_or_hide_question_id]": "string",
  • "question[conditional_display][show_or_hide]": "show",
  • "question[display_order]": 0,
  • "question[label_text]": "string",
  • "question[section_id]": "string",
  • "question[placeholder_text]": "string",
  • "question[help_text]": "string",
  • "question[help_text_position]": "before_input",
  • "question[is_required]": true,
  • "question[min_selections]": 0,
  • "question[max_selections]": 0,
  • "question[input_options]":
    [
    ],
  • "question[conditional_display][and_conditions]":
    [
    ],
  • "question[conditional_display][or_conditions]":
    [
    ]
}

Update an existing question on the form.

Update an existing question. Performing an update does not change any existing responses to the question.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
question[section_id]
string

Identifier of the form section this question belongs to

question[label_text]
string

The label text to be displayed for the question.

question[placeholder_text]
string

Placeholder text to be displayed within the input, if supported by the browser.

question[help_text]
string

Help text to be displayed with the question.

question[help_text_position]
string
Enum: "before_input" "after_input"

Where to position the help text, if help text is provided.

question[display_order]
number

The position of the question within the question list display. If within a section, the order is scoped.

question[is_required]
boolean

Is this question required to be completed?

question[min_selections]
number

If the question is a selection-based question (drop-down, checkbox list, etc.), what is the minimum number of selections that must be made.

question[max_selections]
number

If the question is a selection-based question (drop-down, checkbox list, etc.), what is the maximum number of selections that may be made.

question[input_options]
Array of strings
question[conditional_display][show_or_hide]
string
Enum: "show" "hide"

Show or hide the specified question based on the conditions.

question[conditional_display][show_or_hide_question_id]
string

Identifier of the question to be shown or hide.

question[conditional_display][and_conditions]
Array of strings
question[conditional_display][or_conditions]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "question[section_id]": "string",
  • "question[label_text]": "string",
  • "question[placeholder_text]": "string",
  • "question[help_text]": "string",
  • "question[help_text_position]": "before_input",
  • "question[display_order]": 0,
  • "question[is_required]": true,
  • "question[min_selections]": 0,
  • "question[max_selections]": 0,
  • "question[input_options]":
    [
    ],
  • "question[conditional_display][show_or_hide]": "show",
  • "question[conditional_display][show_or_hide_question_id]": "string",
  • "question[conditional_display][and_conditions]":
    [
    ],
  • "question[conditional_display][or_conditions]":
    [
    ]
}

Update an existing question on the form.

Update an existing question. Performing an update does not change any existing responses to the question.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
question[section_id]
string

Identifier of the form section this question belongs to

question[label_text]
string

The label text to be displayed for the question.

question[placeholder_text]
string

Placeholder text to be displayed within the input, if supported by the browser.

question[help_text]
string

Help text to be displayed with the question.

question[help_text_position]
string
Enum: "before_input" "after_input"

Where to position the help text, if help text is provided.

question[display_order]
number

The position of the question within the question list display. If within a section, the order is scoped.

question[is_required]
boolean

Is this question required to be completed?

question[min_selections]
number

If the question is a selection-based question (drop-down, checkbox list, etc.), what is the minimum number of selections that must be made.

question[max_selections]
number

If the question is a selection-based question (drop-down, checkbox list, etc.), what is the maximum number of selections that may be made.

question[input_options]
Array of strings
question[conditional_display][show_or_hide]
string
Enum: "show" "hide"

Show or hide the specified question based on the conditions.

question[conditional_display][show_or_hide_question_id]
string

Identifier of the question to be shown or hide.

question[conditional_display][and_conditions]
Array of strings
question[conditional_display][or_conditions]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "question[section_id]": "string",
  • "question[label_text]": "string",
  • "question[placeholder_text]": "string",
  • "question[help_text]": "string",
  • "question[help_text_position]": "before_input",
  • "question[display_order]": 0,
  • "question[is_required]": true,
  • "question[min_selections]": 0,
  • "question[max_selections]": 0,
  • "question[input_options]":
    [
    ],
  • "question[conditional_display][show_or_hide]": "show",
  • "question[conditional_display][show_or_hide_question_id]": "string",
  • "question[conditional_display][and_conditions]":
    [
    ],
  • "question[conditional_display][or_conditions]":
    [
    ]
}

Back Office: Forms -> Questions -> Input Options

Returns the input options available for the selected question.

path Parameters
question_id
required
string
form_id
required
string

Responses

Add a new input option to the selected question.

path Parameters
question_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
input_option[display_order]
required
number

The position within the form that this section should appear.

input_option[base_input_option_id]
required
string

Identifier of the base input option from the global repository. Required for non create actions.

input_option[option_label]
required
string

The label to be displayed to users completing a form with this question and input option.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "input_option[display_order]": 0,
  • "input_option[base_input_option_id]": "string",
  • "input_option[option_label]": "string"
}

Return details of a single input option.

path Parameters
id
required
string
question_id
required
string
form_id
required
string

Responses

Update an existing input option.

path Parameters
id
required
string
question_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
input_option[display_order]
required
number

The position within the form that this section should appear.

input_option[base_input_option_id]
required
string

Identifier of the base input option from the global repository. Required for non create actions.

input_option[option_label]
required
string

The label to be displayed to users completing a form with this question and input option.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "input_option[display_order]": 0,
  • "input_option[base_input_option_id]": "string",
  • "input_option[option_label]": "string"
}

Destroy an existing input option.

path Parameters
id
required
string
question_id
required
string
form_id
required
string

Responses

Update an existing input option.

path Parameters
id
required
string
question_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
input_option[display_order]
required
number

The position within the form that this section should appear.

input_option[base_input_option_id]
required
string

Identifier of the base input option from the global repository. Required for non create actions.

input_option[option_label]
required
string

The label to be displayed to users completing a form with this question and input option.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "input_option[display_order]": 0,
  • "input_option[base_input_option_id]": "string",
  • "input_option[option_label]": "string"
}

Back Office: Forms -> Questions -> Validators

Creates a new validator for the question.

path Parameters
question_id
required
string
form_id
required
string

Responses

Updates a question validator. The validator type cannot be changed via this method.

path Parameters
id
required
string
question_id
required
string
form_id
required
string

Responses

Permanently delete a validator from a question.

path Parameters
id
required
string
question_id
required
string
form_id
required
string

Responses

Updates a question validator. The validator type cannot be changed via this method.

path Parameters
id
required
string
question_id
required
string
form_id
required
string

Responses

Back Office: Forms -> Sections

Add a new section to the selected form.

path Parameters
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
section[display_order]
required
number

The position within the form that this section should appear.

section[display_name]
required
boolean

Should the name of the section be displayed to the user.

section[name]
required
string

The name of the section.

section[section_type]
string
Enum: "form_group" "break"

The type of the section. A break would typically appear as a horizontal rule or similar on a form.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "section[display_order]": 0,
  • "section[display_name]": true,
  • "section[name]": "string",
  • "section[section_type]": "form_group"
}

Update an existing form section.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
section[display_order]
required
number

The position within the form that this section should appear.

section[display_name]
required
boolean

Should the name of the section be displayed to the user.

section[name]
required
string

The name of the section.

section[section_type]
string
Enum: "form_group" "break"

The type of the section. A break would typically appear as a horizontal rule or similar on a form.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "section[display_order]": 0,
  • "section[display_name]": true,
  • "section[name]": "string",
  • "section[section_type]": "form_group"
}

Remove a section from the selected form.

Deletes the section from the form, but does NOT delete the questions from the form. Questions contained within a deleted section will be categorized as not in a section.

path Parameters
id
required
string
form_id
required
string

Responses

Update an existing form section.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
section[display_order]
required
number

The position within the form that this section should appear.

section[display_name]
required
boolean

Should the name of the section be displayed to the user.

section[name]
required
string

The name of the section.

section[section_type]
string
Enum: "form_group" "break"

The type of the section. A break would typically appear as a horizontal rule or similar on a form.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "section[display_order]": 0,
  • "section[display_name]": true,
  • "section[name]": "string",
  • "section[section_type]": "form_group"
}

Back Office: Forms Publish

Touch a form.

Touch a form in order to make sure that the cache is current.

path Parameters
id
required
string

Responses

Touch a form.

Touch a form in order to make sure that the cache is current.

path Parameters
id
required
string

Responses

Returns results from question repository.

Request Body schema:
application/json
application/json
multipart/form-data
q[text]
required
string

The keyword or phrase to use when searching the questions repository.

q[search_core]
boolean

T/F for if we are searching Forms::Core or Forms::Forms

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[text]": "string",
  • "q[search_core]": true
}

Returns results from

Request Body schema:
application/json
application/json
multipart/form-data
q[search_term]
required
string

The keyword or phrase to search for

q[limit_to_attributes]
Array of strings

An array of strings of attributes to constraint the search by. ['email', 'name']. Can be nil

q[return_attributes]
Array of strings

Array of attributes to return in the serialization of the results. ['name', 'id']

take
number

The maximum number of results to be returned. Can be nil.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[search_term]": "string",
  • "q[limit_to_attributes]":
    [
    ],
  • "q[return_attributes]":
    [
    ],
  • "take": 0
}

Back Office: Update a Questions Section. Move a question to a nother section

Moves the question from its current section to the new one specified.

path Parameters
question_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
question[section_id]
required
string

The new section ID that we are moving the question to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "question[section_id]": "string"
}

Back Office: Use Forms

List forms used by the object.

path Parameters
id
required
string
group_id
required
string
query Parameters
use_type
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

service_types
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

List forms used by the object.

path Parameters
id
required
string
query Parameters
use_type
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

service_types
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

List forms used by the object.

path Parameters
id
required
string
query Parameters
use_type
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

service_types
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Add the selected form to the object.

path Parameters
id
required
string
group_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used now.

usage[current_use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form is currently being used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[current_use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Add the selected form to the object.

path Parameters
id
required
string
group_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Remove the selected form from the object.

path Parameters
id
required
string
group_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
use_type
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "use_type": "intake"
}

Add the selected form to the object.

path Parameters
id
required
string
group_id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used now.

usage[current_use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form is currently being used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[current_use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Add the selected form to the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used now.

usage[current_use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form is currently being used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[current_use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Add the selected form to the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Remove the selected form from the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
use_type
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "use_type": "intake"
}

Add the selected form to the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used now.

usage[current_use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form is currently being used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[current_use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Add the selected form to the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used now.

usage[current_use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form is currently being used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[current_use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Add the selected form to the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Remove the selected form from the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
use_type
string
Enum: "intake" "exit" "general" "screening"

How should the form be used.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "use_type": "intake"
}

Add the selected form to the object.

path Parameters
id
required
string
form_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
usage[use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form be used now.

usage[current_use_type]
required
string
Enum: "intake" "exit" "general" "screening"

How should the form is currently being used.

usage[service_types]
Array of strings

An array of Service Type identifiers that the form usage should be associated with.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "usage[use_type]": "intake",
  • "usage[current_use_type]": "intake",
  • "usage[service_types]":
    [
    ]
}

Care Coordinators

Updates the assigned Care Coordinator to a Contact

path Parameters
contact_id
required
string
group_id
required
string

Responses

Updates the assigned Care Coordinator to a Contact

path Parameters
contact_id
required
string
group_id
required
string

Responses

Care Team Members: Addresses

Add a new address to the selected Care Team Member.

path Parameters
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
address[country]
required
string

Country for the address.

address[state]
required
string

State or province for the address.

address[postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

address[city]
required
string

City or town of the address.

address[address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

address[line_1]
string

Address line 1

address[line_2]
string

Additional address details, ex. apartment, suite, etc.

address[is_mailing_address]
boolean

Is this a mailing address.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "address[country]": "string",
  • "address[state]": "string",
  • "address[postal_code]": "string",
  • "address[city]": "string",
  • "address[address_type]": "home",
  • "address[line_1]": "string",
  • "address[line_2]": "string",
  • "address[is_mailing_address]": true
}

Update an existing Care Team Member address.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
address[country]
required
string

Country for the address.

address[state]
required
string

State or province for the address.

address[postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

address[city]
required
string

City or town of the address.

address[address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

address[line_1]
string

Address line 1

address[line_2]
string

Additional address details, ex. apartment, suite, etc.

address[is_mailing_address]
boolean

Is this a mailing address.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "address[country]": "string",
  • "address[state]": "string",
  • "address[postal_code]": "string",
  • "address[city]": "string",
  • "address[address_type]": "home",
  • "address[line_1]": "string",
  • "address[line_2]": "string",
  • "address[is_mailing_address]": true
}

Remove an existing Care Team Member address.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string

Responses

Update an existing Care Team Member address.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
address[country]
required
string

Country for the address.

address[state]
required
string

State or province for the address.

address[postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

address[city]
required
string

City or town of the address.

address[address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

address[line_1]
string

Address line 1

address[line_2]
string

Additional address details, ex. apartment, suite, etc.

address[is_mailing_address]
boolean

Is this a mailing address.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "address[country]": "string",
  • "address[state]": "string",
  • "address[postal_code]": "string",
  • "address[city]": "string",
  • "address[address_type]": "home",
  • "address[line_1]": "string",
  • "address[line_2]": "string",
  • "address[is_mailing_address]": true
}

Care Team Members: Email Addresses

Add a new email address to the selected Care Team Member.

path Parameters
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_address[email_address]
required
string

A valid email address

email_address[is_primary]
boolean

Is this email address the primary one for the care team member.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_address[email_address]": "string",
  • "email_address[is_primary]": true
}

Update an existing Care Team Member email address.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_address[email_address]
required
string

A valid email address

email_address[is_primary]
boolean

Is this email address the primary one for the care team member.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_address[email_address]": "string",
  • "email_address[is_primary]": true
}

Remove an existing Care Team Member email address.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string

Responses

Update an existing Care Team Member email address.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_address[email_address]
required
string

A valid email address

email_address[is_primary]
boolean

Is this email address the primary one for the care team member.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_address[email_address]": "string",
  • "email_address[is_primary]": true
}

Care Team Members: Phone Numbers

Add a new phone number to the selected Care Team Member.

path Parameters
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

phone_number[is_primary]
boolean

Is this phone number the care team member's primary contact number.

phone_number[phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

phone_number[can_sms]
boolean

Can this phone number receive SMS?

phone_number[country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[is_primary]": true,
  • "phone_number[phone_type]": "mobile",
  • "phone_number[can_sms]": true,
  • "phone_number[country_code]": "string"
}

Update an existing Care Team Member phone number.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

phone_number[is_primary]
boolean

Is this phone number the care team member's primary contact number.

phone_number[phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

phone_number[can_sms]
boolean

Can this phone number receive SMS?

phone_number[country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[is_primary]": true,
  • "phone_number[phone_type]": "mobile",
  • "phone_number[can_sms]": true,
  • "phone_number[country_code]": "string"
}

Remove an existing Care Team Member phone number.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string

Responses

Update an existing Care Team Member phone number.

path Parameters
id
required
string
member_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

phone_number[is_primary]
boolean

Is this phone number the care team member's primary contact number.

phone_number[phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

phone_number[can_sms]
boolean

Can this phone number receive SMS?

phone_number[country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[is_primary]": true,
  • "phone_number[phone_type]": "mobile",
  • "phone_number[can_sms]": true,
  • "phone_number[country_code]": "string"
}

Cases

Return cases for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string

Responses

Create a new case for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
program[program_id]
required
string

The identifier of the Program the contact and case is being enrolled in.

service_type_id
required
string

The identifier of the requested service type (need).

assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the case.

service_case[description]
string

The full-text details or description of the case.

service_case[primary_worker_id]
string

The user ID of the primary case worker.

service_case[documents]
Array of strings
service_case[out_of_network_providers]
Array of strings
primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

network_id
string

The identifier of the Network that is managing the case.

program[entry_date]
number

Timestamp representing the enrollment date.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "program[program_id]": "string",
  • "service_type_id": "string",
  • "assistance_request_id": "string",
  • "service_case[description]": "string",
  • "service_case[primary_worker_id]": "string",
  • "service_case[documents]":
    [
    ],
  • "service_case[out_of_network_providers]":
    [
    ],
  • "primary_data_source": true,
  • "network_id": "string",
  • "program[entry_date]": 0
}

Return details for the selected case.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Update a case for the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the case.

service_type_id
string

The identifier of the requested service type (need).

service_case[description]
string

The full-text details or description of the case.

service_case[primary_worker_id]
string

The user ID of the primary case worker.

service_case[documents]
Array of strings
service_case[out_of_network_providers]
Array of strings
primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

network_id
string

The identifier of the Network that is managing the case.

program[program_id]
string

The identifier of the Program the contact and case is being enrolled in.

program[entry_date]
number

Timestamp representing the enrollment date.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string",
  • "service_type_id": "string",
  • "service_case[description]": "string",
  • "service_case[primary_worker_id]": "string",
  • "service_case[documents]":
    [
    ],
  • "service_case[out_of_network_providers]":
    [
    ],
  • "primary_data_source": true,
  • "network_id": "string",
  • "program[program_id]": "string",
  • "program[entry_date]": 0
}

Update a case for the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the case.

service_type_id
string

The identifier of the requested service type (need).

service_case[description]
string

The full-text details or description of the case.

service_case[primary_worker_id]
string

The user ID of the primary case worker.

service_case[documents]
Array of strings
service_case[out_of_network_providers]
Array of strings
primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

network_id
string

The identifier of the Network that is managing the case.

program[program_id]
string

The identifier of the Program the contact and case is being enrolled in.

program[entry_date]
number

Timestamp representing the enrollment date.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string",
  • "service_type_id": "string",
  • "service_case[description]": "string",
  • "service_case[primary_worker_id]": "string",
  • "service_case[documents]":
    [
    ],
  • "service_case[out_of_network_providers]":
    [
    ],
  • "primary_data_source": true,
  • "network_id": "string",
  • "program[program_id]": "string",
  • "program[entry_date]": 0
}

Cases: Assessments/Forms

Returns forms that have been completed (at least one response) for the specified case (uses service type).

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string

Responses

Cases: Documents

Displays a list of all the documents attached.

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Displays a single document.

path Parameters
id
required
string
service_case_id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Deletes an attached document.

path Parameters
id
required
string
service_case_id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Cases: Primary Case Worker

Show the primary case worker for the selected case.

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string

Responses

Update the primary case worker for the selected case.

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user_id
required
string

The ID of the user to be set as the primary case worker.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user_id": "string"
}

Update the primary case worker for the selected case.

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user_id
required
string

The ID of the user to be set as the primary case worker.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user_id": "string"
}

Client Gender by Age

Returns a snapshot of Client Gender by Age

path Parameters
group_id
required
string

Responses

Client Military Affiliation by Gender

Returns a snapshot of Client Military Affiliation by Gender

path Parameters
group_id
required
string

Responses

Client Military Branch of Service by Gender

Returns a snapshot of Client Military Branch of Service by Gender

path Parameters
group_id
required
string

Responses

Client Military Service Era by Branch of Service

Returns a snapshot of Client Military Service Era by Branch of Service

path Parameters
group_id
required
string

Responses

Client Military Service Era by Gender

Returns a snapshot of Client Military Service Era by Gender

path Parameters
group_id
required
string

Responses

Client Military Transition Status by Branch of Service

Returns a snapshot of Client Military Transition Status by Branch of Service

path Parameters
group_id
required
string

Responses

Client Military Transitioning by Gender

Returns a snapshot of Client Military Transitioning by Gender

path Parameters
group_id
required
string

Responses

Client Race by Ethnicity

Returns a snapshot of Client Race by Ethnicity

path Parameters
group_id
required
string

Responses

Returns a snapshot of Client Race by Ethnicity

path Parameters
network_id
required
string

Responses

Clients Military Status by Gender

Returns a snapshot of Clients Military Status by Gender

path Parameters
group_id
required
string

Responses

Clients by Age

Returns a snapshot of Clients by Age

path Parameters
group_id
required
string

Responses

Clients by Ethnicity

Returns a snapshot of Clients by Ethnicity

path Parameters
group_id
required
string

Responses

Clients by Gender

Returns a snapshot of Clients by Gender

path Parameters
group_id
required
string

Responses

Clients by Military Affiliation

Returns a snapshot of Clients by Military Affiliation

path Parameters
group_id
required
string

Responses

Clients by Military Branch of Service

Returns a snapshot of Clients by Military Branch of Service

path Parameters
group_id
required
string

Responses

Clients by Military Deployment

Returns a snapshot of Clients by Military Deployment

path Parameters
group_id
required
string

Responses

Clients by Military Discharge

Returns a snapshot of Clients by Military Discharge

path Parameters
group_id
required
string

Responses

Clients by Military Service Era

Returns a snapshot of Clients by Military Service Era

path Parameters
group_id
required
string

Responses

Clients by Military Status

Returns a snapshot of Clients by Military Status

path Parameters
group_id
required
string

Responses

Clients by Military Transitioning Status

Returns a snapshot of Clients by Military Transitioning Status

path Parameters
group_id
required
string

Responses

Clients by Race

Returns a snapshot of Clients by Race

path Parameters
group_id
required
string

Responses

Closed Service Cases by Service Type

Returns a snapshot of Closed Service Cases by Service Type

path Parameters
group_id
required
string

Responses

Closed Service Cases by Service Type and Outcome

Returns a snapshot of Closed Service Cases by Service Type and Outcome

path Parameters
service_type_id
required
string
group_id
required
string

Responses

Closed Service Cases by Sub Types of Service Type

Returns a snapshot of Closed Service Cases by Sub Types of Service Type

path Parameters
service_type_id
required
string
group_id
required
string

Responses

Confirming Two-Factor Authentication (2FA) Registration

Confirm 2FA verification code for a Unite US user account.

Confirms a user's 2FA registration.

Takes a confirmation token from the client and verifies that token with Authy API. A successful confirmation will return a 200 SUCCESS response to the client.

path Parameters
user_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
token
string

The token the user received via SMS.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "token": "string"
}

Resend two-factor authentication (2FA) token to the user's phone number.

Resends a token to the user's phone number in order to confirm their registration process. A successful resend will return a 200 SUCCESS response to the client.

path Parameters
user_id
required
string

Responses

Confirms a user's 2FA registration.

Takes a confirmation token from the client and verifies that token with Authy API. A successful confirmation will return a 200 SUCCESS response to the client.

path Parameters
user_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
token
string

The token the user received via SMS.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "token": "string"
}

Contact: Care Team

Returns the care team members for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Create a new ad-hoc Care Team member for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
member[last_name]
required
string

Team member's last name.

member[first_name]
required
string

Team member's first name.

member[email]
string

Team member's email address.

member[relation_to_contact]
string

Team member's relation to the contact.

member[addresses]
Array of strings
member[email_addresses]
Array of strings
member[phone_numbers]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "member[last_name]": "string",
  • "member[first_name]": "string",
  • "member[email]": "string",
  • "member[relation_to_contact]": "string",
  • "member[addresses]":
    [
    ],
  • "member[email_addresses]":
    [
    ],
  • "member[phone_numbers]":
    [
    ]
}

Updates an existing ad-hoc Care Team member for the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
member[first_name]
string

Team member's first name.

member[last_name]
string

Team member's last name.

member[email]
string

Team member's email address.

member[relation_to_contact]
string

Team member's relation to the contact.

member[addresses]
Array of strings
member[email_addresses]
Array of strings
member[phone_numbers]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "member[first_name]": "string",
  • "member[last_name]": "string",
  • "member[email]": "string",
  • "member[relation_to_contact]": "string",
  • "member[addresses]":
    [
    ],
  • "member[email_addresses]":
    [
    ],
  • "member[phone_numbers]":
    [
    ]
}

Removes an ad-hoc Care Team member from the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates an existing ad-hoc Care Team member for the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
member[first_name]
string

Team member's first name.

member[last_name]
string

Team member's last name.

member[email]
string

Team member's email address.

member[relation_to_contact]
string

Team member's relation to the contact.

member[addresses]
Array of strings
member[email_addresses]
Array of strings
member[phone_numbers]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "member[first_name]": "string",
  • "member[last_name]": "string",
  • "member[email]": "string",
  • "member[relation_to_contact]": "string",
  • "member[addresses]":
    [
    ],
  • "member[email_addresses]":
    [
    ],
  • "member[phone_numbers]":
    [
    ]
}

Contacts

Returns a list of accessible contacts for the selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Creates a new contact for the group and, optionally, network.

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
contact[last_name]
required
string

Contact's last name.

contact[first_name]
required
string

Contact's first name.

network_id
string

The identifier of the Network the contact is participating in.

assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact.

contact[email]
string

Contact's email address.

contact[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

contact[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Contact's specified gender.

contact[citizenship]
string
Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed"

Contact's specified citizenship.

contact[ethnicity]
string
Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed"

Contact's specified ethnicity.

contact[marital_status]
string
Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed"

Contact's specified marital status.

contact[race]
string
Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white"

Contact's specified race.

contact[email_address]
string

Contact's primary email address.

contact[preferred_first_name]
string

Contact's preferred first name.

contact[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Contact's title.

contact[middle_name_initial]
string

Contact's middle name or initial.

contact[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Contact's suffix.

contact[nicknames]
Array of strings

Contact's nicknames.

contact[preferred_communication_method]
string
Enum: "phone_call" "sms" "email" "no_preference"

Preferred communication method

contact[preferred_communication_time_of_day]
string
Enum: "any_time" "morning" "afternoon" "evening"

Preferred communication time of day

contact[addresses]
Array of strings
contact[email_addresses]
Array of strings
contact[phone_numbers]
Array of strings
contact[military][affiliation]
string
Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose"

Military affiliation

contact[military][current_status]
string
Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose"

Current military status

contact[military][currently_transitioning]
string
Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose"

Is the contact currently transitioning?

contact[military][at_least_one_day_active_duty]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has at least one day of active duty outside of basic training?

contact[military][branch]
string
Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose"

Branch of service

contact[military][service_era]
string
Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose"

Service era

contact[military][entry_date]
number

Date of entry

contact[military][exit_date]
number

Date of exit

contact[military][deployed]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Deployed?

contact[military][deployment_starts_at]
number

Deployment start date

contact[military][deployment_ends_at]
number

Deployment end date

contact[military][discharge_type]
string
Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose"

Discharge type

contact[military][discharged_due_to_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Discharged or retired from military service for a disability incurred in the line of duty?

contact[military][service_connected_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has VA-rated Service-Connected Disability?

contact[military][service_connected_disability_rating]
string
Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose"

Service-Connected Disability Rating

contact[military][proof_of_veteran_status]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Have proof of veteran status?

contact[military][proof_type]
string
Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose"

Proof type

contact[insurance_ids]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "contact[last_name]": "string",
  • "contact[first_name]": "string",
  • "network_id": "string",
  • "assistance_request_id": "string",
  • "contact[email]": "string",
  • "contact[date_of_birth]": 0,
  • "contact[gender]": "male",
  • "contact[citizenship]": "us-citizen",
  • "contact[ethnicity]": "hispanic-or-latino",
  • "contact[marital_status]": "divorced",
  • "contact[race]": "american-indian-alaska-native",
  • "contact[email_address]": "string",
  • "contact[preferred_first_name]": "string",
  • "contact[title]": "Mr.",
  • "contact[middle_name_initial]": "string",
  • "contact[suffix]": "Jr.",
  • "contact[nicknames]":
    [
    ],
  • "contact[preferred_communication_method]": "phone_call",
  • "contact[preferred_communication_time_of_day]": "any_time",
  • "contact[addresses]":
    [
    ],
  • "contact[email_addresses]":
    [
    ],
  • "contact[phone_numbers]":
    [
    ],
  • "contact[military][affiliation]": "military_member_or_veteran",
  • "contact[military][current_status]": "active_duty",
  • "contact[military][currently_transitioning]": "yes_12mos_before",
  • "contact[military][at_least_one_day_active_duty]": "yes",
  • "contact[military][branch]": "air_force",
  • "contact[military][service_era]": "post_911",
  • "contact[military][entry_date]": 0,
  • "contact[military][exit_date]": 0,
  • "contact[military][deployed]": "yes",
  • "contact[military][deployment_starts_at]": 0,
  • "contact[military][deployment_ends_at]": 0,
  • "contact[military][discharge_type]": "honorable",
  • "contact[military][discharged_due_to_disability]": "yes",
  • "contact[military][service_connected_disability]": "yes",
  • "contact[military][service_connected_disability_rating]": "0",
  • "contact[military][proof_of_veteran_status]": "yes",
  • "contact[military][proof_type]": "dd214",
  • "contact[insurance_ids]":
    [
    ]
}

Returns details for the selected contact.

path Parameters
id
required
string
group_id
required
string

Responses

Updates a contact.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
network_id
string

The identifier of the Network the contact is participating in.

assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact.

contact[first_name]
string

Contact's first name.

contact[last_name]
string

Contact's last name.

contact[email]
string

Contact's email address.

contact[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

contact[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Contact's specified gender.

contact[citizenship]
string
Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed"

Contact's specified citizenship.

contact[ethnicity]
string
Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed"

Contact's specified ethnicity.

contact[marital_status]
string
Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed"

Contact's specified marital status.

contact[race]
string
Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white"

Contact's specified race.

contact[email_address]
string

Contact's primary email address.

contact[preferred_first_name]
string

Contact's preferred first name.

contact[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Contact's title.

contact[middle_name_initial]
string

Contact's middle name or initial.

contact[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Contact's suffix.

contact[nicknames]
Array of strings

Contact's nicknames.

contact[preferred_communication_method]
string
Enum: "phone_call" "sms" "email" "no_preference"

Preferred communication method

contact[preferred_communication_time_of_day]
string
Enum: "any_time" "morning" "afternoon" "evening"

Preferred communication time of day

contact[addresses]
Array of strings
contact[email_addresses]
Array of strings
contact[phone_numbers]
Array of strings
contact[military][affiliation]
string
Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose"

Military affiliation

contact[military][current_status]
string
Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose"

Current military status

contact[military][currently_transitioning]
string
Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose"

Is the contact currently transitioning?

contact[military][at_least_one_day_active_duty]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has at least one day of active duty outside of basic training?

contact[military][branch]
string
Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose"

Branch of service

contact[military][service_era]
string
Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose"

Service era

contact[military][entry_date]
number

Date of entry

contact[military][exit_date]
number

Date of exit

contact[military][deployed]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Deployed?

contact[military][deployment_starts_at]
number

Deployment start date

contact[military][deployment_ends_at]
number

Deployment end date

contact[military][discharge_type]
string
Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose"

Discharge type

contact[military][discharged_due_to_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Discharged or retired from military service for a disability incurred in the line of duty?

contact[military][service_connected_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has VA-rated Service-Connected Disability?

contact[military][service_connected_disability_rating]
string
Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose"

Service-Connected Disability Rating

contact[military][proof_of_veteran_status]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Have proof of veteran status?

contact[military][proof_type]
string
Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose"

Proof type

contact[insurance_ids]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "network_id": "string",
  • "assistance_request_id": "string",
  • "contact[first_name]": "string",
  • "contact[last_name]": "string",
  • "contact[email]": "string",
  • "contact[date_of_birth]": 0,
  • "contact[gender]": "male",
  • "contact[citizenship]": "us-citizen",
  • "contact[ethnicity]": "hispanic-or-latino",
  • "contact[marital_status]": "divorced",
  • "contact[race]": "american-indian-alaska-native",
  • "contact[email_address]": "string",
  • "contact[preferred_first_name]": "string",
  • "contact[title]": "Mr.",
  • "contact[middle_name_initial]": "string",
  • "contact[suffix]": "Jr.",
  • "contact[nicknames]":
    [
    ],
  • "contact[preferred_communication_method]": "phone_call",
  • "contact[preferred_communication_time_of_day]": "any_time",
  • "contact[addresses]":
    [
    ],
  • "contact[email_addresses]":
    [
    ],
  • "contact[phone_numbers]":
    [
    ],
  • "contact[military][affiliation]": "military_member_or_veteran",
  • "contact[military][current_status]": "active_duty",
  • "contact[military][currently_transitioning]": "yes_12mos_before",
  • "contact[military][at_least_one_day_active_duty]": "yes",
  • "contact[military][branch]": "air_force",
  • "contact[military][service_era]": "post_911",
  • "contact[military][entry_date]": 0,
  • "contact[military][exit_date]": 0,
  • "contact[military][deployed]": "yes",
  • "contact[military][deployment_starts_at]": 0,
  • "contact[military][deployment_ends_at]": 0,
  • "contact[military][discharge_type]": "honorable",
  • "contact[military][discharged_due_to_disability]": "yes",
  • "contact[military][service_connected_disability]": "yes",
  • "contact[military][service_connected_disability_rating]": "0",
  • "contact[military][proof_of_veteran_status]": "yes",
  • "contact[military][proof_type]": "dd214",
  • "contact[insurance_ids]":
    [
    ]
}

Destroys the contact.

path Parameters
id
required
string
group_id
required
string

Responses

Updates a contact.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
network_id
string

The identifier of the Network the contact is participating in.

assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact.

contact[first_name]
string

Contact's first name.

contact[last_name]
string

Contact's last name.

contact[email]
string

Contact's email address.

contact[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

contact[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Contact's specified gender.

contact[citizenship]
string
Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed"

Contact's specified citizenship.

contact[ethnicity]
string
Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed"

Contact's specified ethnicity.

contact[marital_status]
string
Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed"

Contact's specified marital status.

contact[race]
string
Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white"

Contact's specified race.

contact[email_address]
string

Contact's primary email address.

contact[preferred_first_name]
string

Contact's preferred first name.

contact[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Contact's title.

contact[middle_name_initial]
string

Contact's middle name or initial.

contact[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Contact's suffix.

contact[nicknames]
Array of strings

Contact's nicknames.

contact[preferred_communication_method]
string
Enum: "phone_call" "sms" "email" "no_preference"

Preferred communication method

contact[preferred_communication_time_of_day]
string
Enum: "any_time" "morning" "afternoon" "evening"

Preferred communication time of day

contact[addresses]
Array of strings
contact[email_addresses]
Array of strings
contact[phone_numbers]
Array of strings
contact[military][affiliation]
string
Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose"

Military affiliation

contact[military][current_status]
string
Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose"

Current military status

contact[military][currently_transitioning]
string
Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose"

Is the contact currently transitioning?

contact[military][at_least_one_day_active_duty]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has at least one day of active duty outside of basic training?

contact[military][branch]
string
Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose"

Branch of service

contact[military][service_era]
string
Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose"

Service era

contact[military][entry_date]
number

Date of entry

contact[military][exit_date]
number

Date of exit

contact[military][deployed]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Deployed?

contact[military][deployment_starts_at]
number

Deployment start date

contact[military][deployment_ends_at]
number

Deployment end date

contact[military][discharge_type]
string
Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose"

Discharge type

contact[military][discharged_due_to_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Discharged or retired from military service for a disability incurred in the line of duty?

contact[military][service_connected_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has VA-rated Service-Connected Disability?

contact[military][service_connected_disability_rating]
string
Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose"

Service-Connected Disability Rating

contact[military][proof_of_veteran_status]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Have proof of veteran status?

contact[military][proof_type]
string
Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose"

Proof type

contact[insurance_ids]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "network_id": "string",
  • "assistance_request_id": "string",
  • "contact[first_name]": "string",
  • "contact[last_name]": "string",
  • "contact[email]": "string",
  • "contact[date_of_birth]": 0,
  • "contact[gender]": "male",
  • "contact[citizenship]": "us-citizen",
  • "contact[ethnicity]": "hispanic-or-latino",
  • "contact[marital_status]": "divorced",
  • "contact[race]": "american-indian-alaska-native",
  • "contact[email_address]": "string",
  • "contact[preferred_first_name]": "string",
  • "contact[title]": "Mr.",
  • "contact[middle_name_initial]": "string",
  • "contact[suffix]": "Jr.",
  • "contact[nicknames]":
    [
    ],
  • "contact[preferred_communication_method]": "phone_call",
  • "contact[preferred_communication_time_of_day]": "any_time",
  • "contact[addresses]":
    [
    ],
  • "contact[email_addresses]":
    [
    ],
  • "contact[phone_numbers]":
    [
    ],
  • "contact[military][affiliation]": "military_member_or_veteran",
  • "contact[military][current_status]": "active_duty",
  • "contact[military][currently_transitioning]": "yes_12mos_before",
  • "contact[military][at_least_one_day_active_duty]": "yes",
  • "contact[military][branch]": "air_force",
  • "contact[military][service_era]": "post_911",
  • "contact[military][entry_date]": 0,
  • "contact[military][exit_date]": 0,
  • "contact[military][deployed]": "yes",
  • "contact[military][deployment_starts_at]": 0,
  • "contact[military][deployment_ends_at]": 0,
  • "contact[military][discharge_type]": "honorable",
  • "contact[military][discharged_due_to_disability]": "yes",
  • "contact[military][service_connected_disability]": "yes",
  • "contact[military][service_connected_disability_rating]": "0",
  • "contact[military][proof_of_veteran_status]": "yes",
  • "contact[military][proof_type]": "dd214",
  • "contact[insurance_ids]":
    [
    ]
}

Contacts Gender by Age Report

Returns a snapshot of network contacts gender by age

path Parameters
network_id
required
string

Responses

Contacts with Intakes

Returns a list of accessible contacts with intakes for the selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Contacts: Addresses

Add a new address to the selected Contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
address[state]
required
string

State or province for the address.

address[postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

address[city]
required
string

City or town of the address.

address[address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

address[line_1]
string

Address line 1

address[line_2]
string

Additional address details, ex. apartment, suite, etc.

address[country]
string

Country for the address.

address[is_mailing_address]
boolean

Is this a mailing address.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "address[state]": "string",
  • "address[postal_code]": "string",
  • "address[city]": "string",
  • "address[address_type]": "home",
  • "address[line_1]": "string",
  • "address[line_2]": "string",
  • "address[country]": "string",
  • "address[is_mailing_address]": true
}

Update an existing Contact address.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
address[state]
required
string

State or province for the address.

address[postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

address[city]
required
string

City or town of the address.

address[address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

address[line_1]
string

Address line 1

address[line_2]
string

Additional address details, ex. apartment, suite, etc.

address[country]
string

Country for the address.

address[is_mailing_address]
boolean

Is this a mailing address.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "address[state]": "string",
  • "address[postal_code]": "string",
  • "address[city]": "string",
  • "address[address_type]": "home",
  • "address[line_1]": "string",
  • "address[line_2]": "string",
  • "address[country]": "string",
  • "address[is_mailing_address]": true
}

Remove an existing Contact address.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Update an existing Contact address.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
address[state]
required
string

State or province for the address.

address[postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

address[city]
required
string

City or town of the address.

address[address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

address[line_1]
string

Address line 1

address[line_2]
string

Additional address details, ex. apartment, suite, etc.

address[country]
string

Country for the address.

address[is_mailing_address]
boolean

Is this a mailing address.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "address[state]": "string",
  • "address[postal_code]": "string",
  • "address[city]": "string",
  • "address[address_type]": "home",
  • "address[line_1]": "string",
  • "address[line_2]": "string",
  • "address[country]": "string",
  • "address[is_mailing_address]": true
}

Create new email consent request for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
consents[email_address]
required
string

Email you would like to deliver the consent request to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "consents[email_address]": "string"
}

Create new sms consent request for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
consents[phone_number]
required
string

Phone number to deliver the consent request to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "consents[phone_number]": "string"
}

Create and Accepts a new document consent request for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
consents[documents]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "consents[documents]":
    [
    ]
}

Create new consent request URL for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string

Responses

Contacts: Documents

Displays a list of all the documents attached.

path Parameters
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Displays a single document.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Deletes an attached document.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Contacts: Email Addresses

Add a new email address to the selected Contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_address[email_address]
required
string

A valid email address

email_address[is_primary]
boolean

Is this email address the primary one for the contact.

email_address[acceptable_communication_types]
string
Enum: "message" "notification"

Acceptable methods by which to contact the user at this email

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_address[email_address]": "string",
  • "email_address[is_primary]": true,
  • "email_address[acceptable_communication_types]": "message"
}

Update an existing Contact email address.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_address[email_address]
required
string

A valid email address

email_address[is_primary]
boolean

Is this email address the primary one for the contact.

email_address[acceptable_communication_types]
string
Enum: "message" "notification"

Acceptable methods by which to contact the user at this email

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_address[email_address]": "string",
  • "email_address[is_primary]": true,
  • "email_address[acceptable_communication_types]": "message"
}

Remove an existing Contact email address.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Update an existing Contact email address.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_address[email_address]
required
string

A valid email address

email_address[is_primary]
boolean

Is this email address the primary one for the contact.

email_address[acceptable_communication_types]
string
Enum: "message" "notification"

Acceptable methods by which to contact the user at this email

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_address[email_address]": "string",
  • "email_address[is_primary]": true,
  • "email_address[acceptable_communication_types]": "message"
}

Contacts: Filter Timeline Events

Returns a list of filtered events.

Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
q[filter_names]
string
Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team"

Name of filter to be appliied

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[filter_names]": "client_updates",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string"
}

Contacts: Filter by Primary Worker

Returns a list of accessible contacts for which the specified user is the primary worker.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of accessible contacts for which the specified user is the primary worker.

path Parameters
user_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Contacts: Forms

Returns forms available to the selected contact.

path Parameters
contact_id
required
string
group_id
required
string

Responses

Returns form details with any existing responses spliced into the question.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Contacts: Interactions

Creates an interaction.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
collection_class_id
string
interaction[note]
string

Information about the interaction

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "collection_class_id": "string",
  • "interaction[note]": "string"
}

Updates an interaction.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
collection_class_id
string
interaction[note]
string

Information about the interaction

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "collection_class_id": "string",
  • "interaction[note]": "string"
}

Updates an interaction.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
collection_class_id
string
interaction[note]
string

Information about the interaction

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "collection_class_id": "string",
  • "interaction[note]": "string"
}

Contacts: Phone Numbers

Add a new phone number to the selected Contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

phone_number[is_primary]
boolean

Is this phone number the contact's primary contact number.

phone_number[phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

phone_number[can_sms]
boolean

Can this phone number receive SMS?

phone_number[country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

phone_number[acceptable_communication_types]
string
Enum: "phone_call" "message" "notification"

Acceptable methods by which to contact the user at this email

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[is_primary]": true,
  • "phone_number[phone_type]": "mobile",
  • "phone_number[can_sms]": true,
  • "phone_number[country_code]": "string",
  • "phone_number[acceptable_communication_types]": "phone_call"
}

Update an existing Contact phone number.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

phone_number[is_primary]
boolean

Is this phone number the contact's primary contact number.

phone_number[phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

phone_number[can_sms]
boolean

Can this phone number receive SMS?

phone_number[country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

phone_number[acceptable_communication_types]
string
Enum: "phone_call" "message" "notification"

Acceptable methods by which to contact the user at this email

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[is_primary]": true,
  • "phone_number[phone_type]": "mobile",
  • "phone_number[can_sms]": true,
  • "phone_number[country_code]": "string",
  • "phone_number[acceptable_communication_types]": "phone_call"
}

Remove an existing Contact phone number.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Update an existing Contact phone number.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

phone_number[is_primary]
boolean

Is this phone number the contact's primary contact number.

phone_number[phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

phone_number[can_sms]
boolean

Can this phone number receive SMS?

phone_number[country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

phone_number[acceptable_communication_types]
string
Enum: "phone_call" "message" "notification"

Acceptable methods by which to contact the user at this email

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[is_primary]": true,
  • "phone_number[phone_type]": "mobile",
  • "phone_number[can_sms]": true,
  • "phone_number[country_code]": "string",
  • "phone_number[acceptable_communication_types]": "phone_call"
}

Contacts: Program Enrollment

Returns enrollment details for the contact and the selected program.

path Parameters
program_id
required
string
contact_id
required
string
group_id
required
string

Responses

Contacts: Referrals

Returns a list of referrals sent on behalf of the Contact.

path Parameters
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Create new referral(s) for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral.

referrals
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string",
  • "referrals":
    [
    ]
}

Create new referral(s) for the selected contact.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral.

referrals
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string",
  • "referrals":
    [
    ]
}

Returns details for the selected referral.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Branchs a referral for the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral.

referrals
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string",
  • "referrals":
    [
    ]
}

Branchs a referral for the selected contact.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will connect the originating assistance request to the referral.

referrals
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string",
  • "referrals":
    [
    ]
}

Contacts: Respond to Form

Upserts a contact's response to the specified form/assessment.

path Parameters
form_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Upserts a contact's response to the specified form/assessment.

path Parameters
form_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Contacts: Select/Use by Group

Creates a relationship between the selected contact and the Group.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string"
}

Creates a relationship between the selected contact and the Group.

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
assistance_request_id
string

The identifier of an assistance request submitted by the Contact. This will cause the API to attempt to transfer data from the assistance request requestor to the Contact.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request_id": "string"
}

Contacts: Timeline Events

Returns a list of events for the selected Contact.

Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Document Deletion

Create new documents for provided resources

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
resource_ids
required
Array of strings

The ids of the resources from which the document will be removed

document_id
required
string

The id of the document to remove

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "resource_ids":
    [
    ],
  • "document_id": "string"
}

Documents

Assign existing documents to provided resources

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
options[attach_to_contact]
boolean

A boolean specifying whether to attach documents to the contact

options[resource_ids]
Array of strings

An array of ids for cases, referrals, intakes for a contact

document_ids
Array of strings

The ids of existing documents

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "options[attach_to_contact]": true,
  • "options[resource_ids]":
    [
    ],
  • "document_ids":
    [
    ]
}

Assign existing documents to provided resources

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
options[attach_to_contact]
boolean

A boolean specifying whether to attach documents to the contact

options[resource_ids]
Array of strings

An array of ids for cases, referrals, intakes for a contact

document_ids
Array of strings

The ids of existing documents

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "options[attach_to_contact]": true,
  • "options[resource_ids]":
    [
    ],
  • "document_ids":
    [
    ]
}

EMR Context

Return patient context

path Parameters
group_id
required
string

Responses

EMR Patient Contact Information

Update contact information using the current patient's information

path Parameters
group_id
required
string

Responses

EMR Patient Contact association

Associates an existing contact with an emr patient

path Parameters
contact_id
required
string
group_id
required
string

Responses

Exports

Retrieve a paginated list of all exports belonging to the current group

path Parameters
group_id
required
string

Responses

Create a new export

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
export[send_email]
required
boolean

Should send email?

export[time_field]
required
string
Enum: "created_at" "updated_at" "created_or_updated"

To which timestamp field should export apply the time constraint

export[type]
required
string
Enum: "assessment" "contact" "interaction" "referral" "service_case" "service_episode_raw" "service_episode_snapshot" "user"

Type of export that should be created

export[target_type]
required
string
Enum: "network" "provider"

Type of target that is being provided

export[target_ids]
Array of strings

Array of IDs that identify the targets of the export (ie: Group or Network IDs)

export[start_at]
string

Earliest date for export (yyyy-mm-dd)

export[end_at]
string

Ending date for export (yyyy-mm-dd)

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "export[send_email]": true,
  • "export[time_field]": "created_at",
  • "export[type]": "assessment",
  • "export[target_type]": "network",
  • "export[target_ids]":
    [
    ],
  • "export[start_at]": "string",
  • "export[end_at]": "string"
}

Global Contact Notification Settings for Users

Returns contact notification settings for the current user and a contact

path Parameters
id
required
string
query Parameters
new_case
boolean

new case

case_status_change
boolean

case status changed

referral_made
boolean

referral made

referral_declined
boolean

referral declined

referral_or_case_assigned
boolean

referral or case assigned

contact_updated
boolean

contact updated

contact_new_note
boolean

contact new note added

contact_case_updated
boolean

contact case updated

contact_case_new_note
boolean

contact case new note

contact_case_new_document
boolean

contact case new document

contact_assessment_updated
boolean

contact assessement updated

care_team_member_added
boolean

care team member added

care_team_member_updated
boolean

care team member updated

care_team_member_removed
boolean

care team member removed

primary_worker_assigned_to_case
boolean

primary worked assigned to case

accepted_informed_consent
boolean

accepted informed consent

declined_informed_consent
boolean

declined informed consent

care_coordinator_assigned
boolean

care coordinator assigned

Responses

Returns contact notification settings for the current user and a contact

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
new_case
boolean

new case

case_status_change
boolean

case status changed

referral_made
boolean

referral made

referral_declined
boolean

referral declined

referral_or_case_assigned
boolean

referral or case assigned

contact_updated
boolean

contact updated

contact_new_note
boolean

contact new note added

contact_case_updated
boolean

contact case updated

contact_case_new_note
boolean

contact case new note

contact_case_new_document
boolean

contact case new document

contact_assessment_updated
boolean

contact assessement updated

care_team_member_added
boolean

care team member added

care_team_member_updated
boolean

care team member updated

care_team_member_removed
boolean

care team member removed

primary_worker_assigned_to_case
boolean

primary worked assigned to case

accepted_informed_consent
boolean

accepted informed consent

declined_informed_consent
boolean

declined informed consent

care_coordinator_assigned
boolean

care coordinator assigned

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "new_case": true,
  • "case_status_change": true,
  • "referral_made": true,
  • "referral_declined": true,
  • "referral_or_case_assigned": true,
  • "contact_updated": true,
  • "contact_new_note": true,
  • "contact_case_updated": true,
  • "contact_case_new_note": true,
  • "contact_case_new_document": true,
  • "contact_assessment_updated": true,
  • "care_team_member_added": true,
  • "care_team_member_updated": true,
  • "care_team_member_removed": true,
  • "primary_worker_assigned_to_case": true,
  • "accepted_informed_consent": true,
  • "declined_informed_consent": true,
  • "care_coordinator_assigned": true
}

Returns contact notification settings for the current user and a contact

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
new_case
boolean

new case

case_status_change
boolean

case status changed

referral_made
boolean

referral made

referral_declined
boolean

referral declined

referral_or_case_assigned
boolean

referral or case assigned

contact_updated
boolean

contact updated

contact_new_note
boolean

contact new note added

contact_case_updated
boolean

contact case updated

contact_case_new_note
boolean

contact case new note

contact_case_new_document
boolean

contact case new document

contact_assessment_updated
boolean

contact assessement updated

care_team_member_added
boolean

care team member added

care_team_member_updated
boolean

care team member updated

care_team_member_removed
boolean

care team member removed

primary_worker_assigned_to_case
boolean

primary worked assigned to case

accepted_informed_consent
boolean

accepted informed consent

declined_informed_consent
boolean

declined informed consent

care_coordinator_assigned
boolean

care coordinator assigned

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "new_case": true,
  • "case_status_change": true,
  • "referral_made": true,
  • "referral_declined": true,
  • "referral_or_case_assigned": true,
  • "contact_updated": true,
  • "contact_new_note": true,
  • "contact_case_updated": true,
  • "contact_case_new_note": true,
  • "contact_case_new_document": true,
  • "contact_assessment_updated": true,
  • "care_team_member_added": true,
  • "care_team_member_updated": true,
  • "care_team_member_removed": true,
  • "primary_worker_assigned_to_case": true,
  • "accepted_informed_consent": true,
  • "declined_informed_consent": true,
  • "care_coordinator_assigned": true
}

Global Notification Settings for Users

Shows global notification settings for the user

path Parameters
id
required
string
query Parameters
email_updates_enabled
boolean

Global email on/off settings

update_when_someone_mentions_me
string
Enum: "off" "email_only"

Methods to alert the user

Responses

Updates global notification settings for the user

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_updates_enabled
boolean

Global email on/off settings

update_when_someone_mentions_me
string
Enum: "off" "email_only"

Methods to alert the user

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_updates_enabled": true,
  • "update_when_someone_mentions_me": "off"
}

Updates global notification settings for the user

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
email_updates_enabled
boolean

Global email on/off settings

update_when_someone_mentions_me
string
Enum: "off" "email_only"

Methods to alert the user

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "email_updates_enabled": true,
  • "update_when_someone_mentions_me": "off"
}

Group Cases: Enrollment

Updates the case program enrollment

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
enrollment[referred_to]
string

Freeform text for information about where the client was referred

enrollment[enrolled_at]
number

Timestamp representing the enrollment date.

enrollment[exited_at]
number

Timestamp representing the exit date.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "enrollment[referred_to]": "string",
  • "enrollment[enrolled_at]": 0,
  • "enrollment[exited_at]": 0
}

Updates the case program enrollment

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
enrollment[referred_to]
string

Freeform text for information about where the client was referred

enrollment[enrolled_at]
number

Timestamp representing the enrollment date.

enrollment[exited_at]
number

Timestamp representing the exit date.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "enrollment[referred_to]": "string",
  • "enrollment[enrolled_at]": 0,
  • "enrollment[exited_at]": 0
}

Group sharing

Sends a message in order to share a group with someone

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
message[group_id]
required
string

The id of the group to share

message[message_method]
required
string
Enum: "email" "sms"

How the message is to be sent

message[to]
required
string

The phone number or email address of the recipient

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "message[group_id]": "string",
  • "message[message_method]": "email",
  • "message[to]": "string"
}

Groups

Returns details about the selected Group.

path Parameters
id
required
string

Responses

Retrieve a complete group profile.

path Parameters
id
required
string

Responses

Update a group profile.

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
group[consent_enabled]
required
boolean

Is consent enabled for this organization?

group[name]
string

The name of the group.

group[description]
string

Description of the group

group[founded_year]
number

The year the group was founded.

group[logo_data_uri]
string

Base64 encoded string of the image to be used for the organization logo.

group[org_schedule]
Array of strings

The hours of operation for the organization.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "group[consent_enabled]": true,
  • "group[name]": "string",
  • "group[description]": "string",
  • "group[founded_year]": 0,
  • "group[logo_data_uri]": "string",
  • "group[org_schedule]":
    [
    ]
}

Update a group profile.

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
group[consent_enabled]
required
boolean

Is consent enabled for this organization?

group[name]
string

The name of the group.

group[description]
string

Description of the group

group[founded_year]
number

The year the group was founded.

group[logo_data_uri]
string

Base64 encoded string of the image to be used for the organization logo.

group[org_schedule]
Array of strings

The hours of operation for the organization.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "group[consent_enabled]": true,
  • "group[name]": "string",
  • "group[description]": "string",
  • "group[founded_year]": 0,
  • "group[logo_data_uri]": "string",
  • "group[org_schedule]":
    [
    ]
}

Groups -> Assistance Requests: Forms

Returns form details with any existing responses spliced into the question.

path Parameters
assistance_request_id
required
string
group_id
required
string

Responses

Returns forms available to the selected assistance request.

path Parameters
assistance_request_id
required
string
group_id
required
string

Responses

Groups Service Types: Outcomes

Returns all outcomes provided by the specified groups service_type.

path Parameters
service_type_id
required
string
group_id
required
string

Responses

Groups: Assistance Request Form Config

Shows the assistance request form configuration for the selected group.

path Parameters
group_id
required
string

Responses

Groups: Assistance Requests

Returns a list of assistance requests sent to selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

q[service_types]
Array of strings

Array of service type IDs to filter results by.

Responses

Returns a list of assistance requests sent to selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

q[service_types]
Array of strings

Array of service type IDs to filter results by.

Responses

Returns a list of assistance requests sent to selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

q[service_types]
Array of strings

Array of service type IDs to filter results by.

Responses

Returns a list of assistance requests sent to selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

q[service_types]
Array of strings

Array of service type IDs to filter results by.

Responses

Returns a list of assistance requests sent to selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

q[service_types]
Array of strings

Array of service type IDs to filter results by.

Responses

Returns a list of assistance requests sent to selected Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

q[service_types]
Array of strings

Array of service type IDs to filter results by.

Responses

Returns details for the selected assistance request.

path Parameters
id
required
string
group_id
required
string

Responses

Groups: Cases

Returns a list of Cases serviced by the Group.

path Parameters
group_id
required
string
query Parameters
closed
boolean

Boolean value to hide or show only closed cases. Omit for open and closed.

primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

q[service_types]
Array of strings

Array of service type uuids on which to filter.

q[groups]
Array of strings

Array of group uuids on which to filter.

q[networks]
Array of strings

Array of network uuids on which to filter.

q[programs]
Array of strings

Array of program uuids on which to filter.

q[care_coordinator_users]
Array of strings

Array of user uuids on which to filter.

q[primary_worker_users]
Array of strings

Array of user uuids on which to filter.

q[resolved]
boolean

Boolean value - true for resolved, false for unresolved. Omit for all.

q[network_inclusion_scope]
string
Enum: "in" "out"

Cases in or out of network. Omit for both.

q[provider_scope]
string
Enum: "group" "network"

Case manged by a network or group. Omit for both.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of Cases serviced by the Group.

path Parameters
group_id
required
string
query Parameters
closed
boolean

Boolean value to hide or show only closed cases. Omit for open and closed.

primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

q[service_types]
Array of strings

Array of service type uuids on which to filter.

q[groups]
Array of strings

Array of group uuids on which to filter.

q[networks]
Array of strings

Array of network uuids on which to filter.

q[programs]
Array of strings

Array of program uuids on which to filter.

q[care_coordinator_users]
Array of strings

Array of user uuids on which to filter.

q[primary_worker_users]
Array of strings

Array of user uuids on which to filter.

q[resolved]
boolean

Boolean value - true for resolved, false for unresolved. Omit for all.

q[network_inclusion_scope]
string
Enum: "in" "out"

Cases in or out of network. Omit for both.

q[provider_scope]
string
Enum: "group" "network"

Case manged by a network or group. Omit for both.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of Cases serviced by the Group.

path Parameters
group_id
required
string
query Parameters
closed
boolean

Boolean value to hide or show only closed cases. Omit for open and closed.

primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

q[service_types]
Array of strings

Array of service type uuids on which to filter.

q[groups]
Array of strings

Array of group uuids on which to filter.

q[networks]
Array of strings

Array of network uuids on which to filter.

q[programs]
Array of strings

Array of program uuids on which to filter.

q[care_coordinator_users]
Array of strings

Array of user uuids on which to filter.

q[primary_worker_users]
Array of strings

Array of user uuids on which to filter.

q[resolved]
boolean

Boolean value - true for resolved, false for unresolved. Omit for all.

q[network_inclusion_scope]
string
Enum: "in" "out"

Cases in or out of network. Omit for both.

q[provider_scope]
string
Enum: "group" "network"

Case manged by a network or group. Omit for both.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of Cases serviced by the Group.

path Parameters
group_id
required
string
query Parameters
closed
boolean

Boolean value to hide or show only closed cases. Omit for open and closed.

primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

q[service_types]
Array of strings

Array of service type uuids on which to filter.

q[groups]
Array of strings

Array of group uuids on which to filter.

q[networks]
Array of strings

Array of network uuids on which to filter.

q[programs]
Array of strings

Array of program uuids on which to filter.

q[care_coordinator_users]
Array of strings

Array of user uuids on which to filter.

q[primary_worker_users]
Array of strings

Array of user uuids on which to filter.

q[resolved]
boolean

Boolean value - true for resolved, false for unresolved. Omit for all.

q[network_inclusion_scope]
string
Enum: "in" "out"

Cases in or out of network. Omit for both.

q[provider_scope]
string
Enum: "group" "network"

Case manged by a network or group. Omit for both.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of Cases serviced by the Group.

path Parameters
group_id
required
string
query Parameters
closed
boolean

Boolean value to hide or show only closed cases. Omit for open and closed.

primary_data_source
boolean

Boolean to disable performance optimization for retrieving service cases.

q[service_types]
Array of strings

Array of service type uuids on which to filter.

q[groups]
Array of strings

Array of group uuids on which to filter.

q[networks]
Array of strings

Array of network uuids on which to filter.

q[programs]
Array of strings

Array of program uuids on which to filter.

q[care_coordinator_users]
Array of strings

Array of user uuids on which to filter.

q[primary_worker_users]
Array of strings

Array of user uuids on which to filter.

q[resolved]
boolean

Boolean value - true for resolved, false for unresolved. Omit for all.

q[network_inclusion_scope]
string
Enum: "in" "out"

Cases in or out of network. Omit for both.

q[provider_scope]
string
Enum: "group" "network"

Case manged by a network or group. Omit for both.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Cases Converted from Sent Referrals

Returns a list of Cases converted from Referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
closed
boolean

Boolean value to hide or show only closed cases. Omit for open and closed.

q[referral_sender_users]
Array of strings

Array of referral sending user uuids.

q[service_types]
Array of strings

Array of service type uuids.

q[resolved]
boolean

Boolean value - true for resolved, false for unresolved. Omit for all.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Closed Referrals

Return a list of closed Referrals

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Set the selected referral to closed and create a closing node

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
closing[outcome_id]
required
string

The id of the outcome this closing is associated with

closing[status]
required
string
Enum: "resolved" "unresolved"

The status of the case; either resolved or unresolved.

closing[note]
string

A note pertaining to the closing

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "closing[outcome_id]": "string",
  • "closing[status]": "resolved",
  • "closing[note]": "string"
}

Set the selected referral to closed and create a closing node

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
closing[outcome_id]
required
string

The id of the outcome this closing is associated with

closing[status]
required
string
Enum: "resolved" "unresolved"

The status of the case; either resolved or unresolved.

closing[note]
string

A note pertaining to the closing

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "closing[outcome_id]": "string",
  • "closing[status]": "resolved",
  • "closing[note]": "string"
}

Groups: Draft Referrals

Returns a list of draft referrals for the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns details for the selected draft referral.

path Parameters
id
required
string
group_id
required
string

Responses

Updates the details of the selected referral.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral[description]
string

Referral notes or description.

referral[referred_by_network_id]
string

Network from which the referral will be sent.

referral[referred_to_network_id]
string

Network to which the referral will be sent.

referral[service_type]
string

Service type for the referral.

referral[documents]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral[description]": "string",
  • "referral[referred_by_network_id]": "string",
  • "referral[referred_to_network_id]": "string",
  • "referral[service_type]": "string",
  • "referral[documents]":
    [
    ]
}

Deletes the selected draft referral.

path Parameters
id
required
string
group_id
required
string

Responses

Updates the details of the selected referral.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral[description]
string

Referral notes or description.

referral[referred_by_network_id]
string

Network from which the referral will be sent.

referral[referred_to_network_id]
string

Network to which the referral will be sent.

referral[service_type]
string

Service type for the referral.

referral[documents]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral[description]": "string",
  • "referral[referred_by_network_id]": "string",
  • "referral[referred_to_network_id]": "string",
  • "referral[service_type]": "string",
  • "referral[documents]":
    [
    ]
}

Groups: Filter Timeline Events

Returns a list of filtered events.

Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
q[filter_names]
string
Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team"

Name of filter to be appliied

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[filter_names]": "client_updates",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string"
}

Groups: Forms Available for Use

Retrieve a complete group profile.

path Parameters
group_id
required
string
query Parameters
q[use_type]
string
Enum: "intake" "exit" "general" "screening" "any"

Limit the available forms returned to the specified use type.

q[service_type_ids]
Array of strings

Identifiers of the service type(s) being provided.

q[network_ids]
string

Identifiers of the Network(s) being used to provide the service.

q[program_id]
string

Identifier of the Program being used to provide the service.

q[contact_id]
string

Identifier of the Contact that will be attached to the used forms.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Forms Returns a form with a single question containing only the questions marked as intake

Groups: Hours of Operation

Update hours of operation for the selected Group

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
schedule[week]
Array of strings

The hours of operation for the provided day

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "schedule[week]":
    [
    ]
}

Add hours of operation to the selected Group

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
schedule[week]
Array of strings

The hours of operation for the provided day

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "schedule[week]":
    [
    ]
}

Delete hours of operation for the selected Group

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
schedule[week]
Array of strings

The hours of operation for the provided day

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "schedule[week]":
    [
    ]
}

Update hours of operation for the selected Group

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
schedule[week]
Array of strings

The hours of operation for the provided day

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "schedule[week]":
    [
    ]
}

Groups: Open Channel referrals

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals which were neither sent nor received by the Coordination Center.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Program Users

Returns a list of users with access to the program.

path Parameters
program_id
required
string
group_id
required
string
query Parameters
q[text]
string

Query to search user's first or last name

q[employ_state]
string
Enum: "is_active" "is_inactive" "any"

Filter the results returned by the user's employment status with the group.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Updates a user's access to the selected program.

path Parameters
id
required
string
program_id
required
string
group_id
required
string

Responses

Removes a user from the selected program.

path Parameters
id
required
string
program_id
required
string
group_id
required
string

Responses

Updates a user's access to the selected program.

path Parameters
id
required
string
program_id
required
string
group_id
required
string

Responses

Groups: Programs

Returns a list of programs available to the group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns details of the selected program.

path Parameters
id
required
string
group_id
required
string

Responses

Groups: Referral Contact

Returns details for the contact connected to the selected referral.

path Parameters
referral_id
required
string
group_id
required
string

Responses

Updates a contact.

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
contact[first_name]
string

Contact's first name.

contact[last_name]
string

Contact's last name.

contact[email]
string

Contact's email address.

contact[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

contact[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Contact's specified gender.

contact[citizenship]
string
Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed"

Contact's specified citizenship.

contact[ethnicity]
string
Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed"

Contact's specified ethnicity.

contact[marital_status]
string
Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed"

Contact's specified marital status.

contact[race]
string
Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white"

Contact's specified race.

contact[email_address]
string

Contact's primary email address.

contact[preferred_first_name]
string

Contact's preferred first name.

contact[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Contact's title.

contact[middle_name_initial]
string

Contact's middle name or initial.

contact[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Contact's suffix.

contact[nicknames]
Array of strings

Contact's nicknames.

contact[addresses]
Array of strings
contact[email_addresses]
Array of strings
contact[phone_numbers]
Array of strings
contact[military][affiliation]
string
Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose"

Military affiliation

contact[military][current_status]
string
Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose"

Current military status

contact[military][currently_transitioning]
string
Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose"

Is the contact currently transitioning?

contact[military][at_least_one_day_active_duty]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has at least one day of active duty outside of basic training?

contact[military][branch]
string
Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose"

Branch of service

contact[military][service_era]
string
Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose"

Service era

contact[military][entry_date]
number

Date of entry

contact[military][exit_date]
number

Date of exit

contact[military][deployed]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Deployed?

contact[military][deployment_starts_at]
number

Deployment start date

contact[military][deployment_ends_at]
number

Deployment end date

contact[military][discharge_type]
string
Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose"

Discharge type

contact[military][discharged_due_to_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Discharged or retired from military service for a disability incurred in the line of duty?

contact[military][service_connected_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has VA-rated Service-Connected Disability?

contact[military][service_connected_disability_rating]
string
Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose"

Service-Connected Disability Rating

contact[military][proof_of_veteran_status]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Have proof of veteran status?

contact[military][proof_type]
string
Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose"

Proof type

contact[data]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "contact[first_name]": "string",
  • "contact[last_name]": "string",
  • "contact[email]": "string",
  • "contact[date_of_birth]": 0,
  • "contact[gender]": "male",
  • "contact[citizenship]": "us-citizen",
  • "contact[ethnicity]": "hispanic-or-latino",
  • "contact[marital_status]": "divorced",
  • "contact[race]": "american-indian-alaska-native",
  • "contact[email_address]": "string",
  • "contact[preferred_first_name]": "string",
  • "contact[title]": "Mr.",
  • "contact[middle_name_initial]": "string",
  • "contact[suffix]": "Jr.",
  • "contact[nicknames]":
    [
    ],
  • "contact[addresses]":
    [
    ],
  • "contact[email_addresses]":
    [
    ],
  • "contact[phone_numbers]":
    [
    ],
  • "contact[military][affiliation]": "military_member_or_veteran",
  • "contact[military][current_status]": "active_duty",
  • "contact[military][currently_transitioning]": "yes_12mos_before",
  • "contact[military][at_least_one_day_active_duty]": "yes",
  • "contact[military][branch]": "air_force",
  • "contact[military][service_era]": "post_911",
  • "contact[military][entry_date]": 0,
  • "contact[military][exit_date]": 0,
  • "contact[military][deployed]": "yes",
  • "contact[military][deployment_starts_at]": 0,
  • "contact[military][deployment_ends_at]": 0,
  • "contact[military][discharge_type]": "honorable",
  • "contact[military][discharged_due_to_disability]": "yes",
  • "contact[military][service_connected_disability]": "yes",
  • "contact[military][service_connected_disability_rating]": "0",
  • "contact[military][proof_of_veteran_status]": "yes",
  • "contact[military][proof_type]": "dd214",
  • "contact[data]":
    [
    ]
}

Updates a contact.

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
contact[first_name]
string

Contact's first name.

contact[last_name]
string

Contact's last name.

contact[email]
string

Contact's email address.

contact[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

contact[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Contact's specified gender.

contact[citizenship]
string
Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed"

Contact's specified citizenship.

contact[ethnicity]
string
Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed"

Contact's specified ethnicity.

contact[marital_status]
string
Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed"

Contact's specified marital status.

contact[race]
string
Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white"

Contact's specified race.

contact[email_address]
string

Contact's primary email address.

contact[preferred_first_name]
string

Contact's preferred first name.

contact[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Contact's title.

contact[middle_name_initial]
string

Contact's middle name or initial.

contact[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Contact's suffix.

contact[nicknames]
Array of strings

Contact's nicknames.

contact[addresses]
Array of strings
contact[email_addresses]
Array of strings
contact[phone_numbers]
Array of strings
contact[military][affiliation]
string
Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose"

Military affiliation

contact[military][current_status]
string
Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose"

Current military status

contact[military][currently_transitioning]
string
Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose"

Is the contact currently transitioning?

contact[military][at_least_one_day_active_duty]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has at least one day of active duty outside of basic training?

contact[military][branch]
string
Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose"

Branch of service

contact[military][service_era]
string
Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose"

Service era

contact[military][entry_date]
number

Date of entry

contact[military][exit_date]
number

Date of exit

contact[military][deployed]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Deployed?

contact[military][deployment_starts_at]
number

Deployment start date

contact[military][deployment_ends_at]
number

Deployment end date

contact[military][discharge_type]
string
Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose"

Discharge type

contact[military][discharged_due_to_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Discharged or retired from military service for a disability incurred in the line of duty?

contact[military][service_connected_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has VA-rated Service-Connected Disability?

contact[military][service_connected_disability_rating]
string
Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose"

Service-Connected Disability Rating

contact[military][proof_of_veteran_status]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Have proof of veteran status?

contact[military][proof_type]
string
Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose"

Proof type

contact[data]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "contact[first_name]": "string",
  • "contact[last_name]": "string",
  • "contact[email]": "string",
  • "contact[date_of_birth]": 0,
  • "contact[gender]": "male",
  • "contact[citizenship]": "us-citizen",
  • "contact[ethnicity]": "hispanic-or-latino",
  • "contact[marital_status]": "divorced",
  • "contact[race]": "american-indian-alaska-native",
  • "contact[email_address]": "string",
  • "contact[preferred_first_name]": "string",
  • "contact[title]": "Mr.",
  • "contact[middle_name_initial]": "string",
  • "contact[suffix]": "Jr.",
  • "contact[nicknames]":
    [
    ],
  • "contact[addresses]":
    [
    ],
  • "contact[email_addresses]":
    [
    ],
  • "contact[phone_numbers]":
    [
    ],
  • "contact[military][affiliation]": "military_member_or_veteran",
  • "contact[military][current_status]": "active_duty",
  • "contact[military][currently_transitioning]": "yes_12mos_before",
  • "contact[military][at_least_one_day_active_duty]": "yes",
  • "contact[military][branch]": "air_force",
  • "contact[military][service_era]": "post_911",
  • "contact[military][entry_date]": 0,
  • "contact[military][exit_date]": 0,
  • "contact[military][deployed]": "yes",
  • "contact[military][deployment_starts_at]": 0,
  • "contact[military][deployment_ends_at]": 0,
  • "contact[military][discharge_type]": "honorable",
  • "contact[military][discharged_due_to_disability]": "yes",
  • "contact[military][service_connected_disability]": "yes",
  • "contact[military][service_connected_disability_rating]": "0",
  • "contact[military][proof_of_veteran_status]": "yes",
  • "contact[military][proof_type]": "dd214",
  • "contact[data]":
    [
    ]
}

Groups: Referral Contact Forms

Returns form details with any existing responses spliced into the question.

path Parameters
id
required
string
referral_id
required
string
group_id
required
string

Responses

Groups: Referral Contact Program Enrollment

Returns enrollment details for the contact and the selected program.

path Parameters
program_id
required
string
referral_id
required
string
group_id
required
string

Responses

Groups: Referral Contact Respond to Form

Upserts a contact's response to the specified form/assessment.

path Parameters
form_id
required
string
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Upserts a contact's response to the specified form/assessment.

path Parameters
form_id
required
string
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Groups: Referrals

Returns details for the selected referral.

path Parameters
id
required
string
group_id
required
string

Responses

Updates the details of the selected referral.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral[description]
string

Referral notes or description.

referral[referred_by_network_id]
string

Network from which the referral will be sent.

referral[referred_to_network_id]
string

Network to which the referral will be sent.

referral[service_type]
string

Service type for the referral.

referral[documents]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral[description]": "string",
  • "referral[referred_by_network_id]": "string",
  • "referral[referred_to_network_id]": "string",
  • "referral[service_type]": "string",
  • "referral[documents]":
    [
    ]
}

Updates the details of the selected referral.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral[description]
string

Referral notes or description.

referral[referred_by_network_id]
string

Network from which the referral will be sent.

referral[referred_to_network_id]
string

Network to which the referral will be sent.

referral[service_type]
string

Service type for the referral.

referral[documents]
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral[description]": "string",
  • "referral[referred_by_network_id]": "string",
  • "referral[referred_to_network_id]": "string",
  • "referral[service_type]": "string",
  • "referral[documents]":
    [
    ]
}

Groups: Referrals Received

Returns a list of referrals received by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals received by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals received by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Referrals Sent

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns a list of referrals sent by the Group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Screenings

Retrieve a screening for a group

path Parameters
id
required
string
group_id
required
string

Responses

Groups: Search -> Global Contacts

Search the group's contacts using a keyword or phrase.

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
q[last_name]
required
string

Last name of contact being queried.

q[first_name]
required
string

First name of the contact being queried.

q[ssn]
string

Complete Social Security Number of contact being queried. (not yet supported)

q[ssn_last4]
string

Last 4 digits of Social Security Number of contact being queried. (not yet supported)

q[date_of_birth]
string

UNIX timestamp representing the birth date of the contact being queried.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[last_name]": "string",
  • "q[first_name]": "string",
  • "q[ssn]": "string",
  • "q[ssn_last4]": "string",
  • "q[date_of_birth]": "string"
}

Groups: Service Case Contact Forms

Returns form details with any existing responses spliced into the question.

path Parameters
id
required
string
service_case_id
required
string
group_id
required
string

Responses

Groups: Service Case Contact Respond to Form

Upserts a contact's response to the specified form/assessment.

path Parameters
form_id
required
string
service_case_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Upserts a contact's response to the specified form/assessment.

path Parameters
form_id
required
string
service_case_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Groups: Service Types Offered

Returns all service types provided by the specified group.

path Parameters
group_id
required
string
query Parameters
q[group_id]
string

ID of group which should be used to filter results; defaults to current group

q[program_id]
string

ID of program which should be used to filter results

Responses

Groups: Service Types Offered along with Outcomes scope to the Group

Returns all service types with outcomes provided by the specified group.

path Parameters
group_id
required
string

Responses

Returns a specific service type with outcomes provided by the specified group.

path Parameters
service_type_id
required
string
group_id
required
string

Responses

Groups: Service Types Offered: Sub-Types

Returns the list of sub-service/case types for the selected service/case type.

path Parameters
service_type_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: Timeline Events

Returns a list of events for the selected Contact.

Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups: UniteUs Partcipation Agreements

Organization Administrators Accept Participation Agreement on Behalf of a Group

Accept participation agreement for an organization.

Accepts the participation agreement for a group. A successful acceptance will return a 201 CREATED response to the client.

path Parameters
group_id
required
string

Responses

Groups: User Invitation Reminders

Re-send an invitation to join the selected group.

path Parameters
invitation_id
required
string
group_id
required
string

Responses

Groups: User Invitations

Returns a list of invitations sent by the selected group.

path Parameters
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Creates a new user invitation for the selected group.

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
invitation[last_name]
required
string

Last name of the invitation recipient.

invitation[first_name]
required
string

First name of the invitation recipient.

invitation[email]
required
string

Email address where the invitation should be delivered.

invitation[send_immediately]
boolean

Should the invitation be delivered immediately. Defaults to false.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "invitation[last_name]": "string",
  • "invitation[first_name]": "string",
  • "invitation[email]": "string",
  • "invitation[send_immediately]": true
}

Returns details for an invitation.

path Parameters
id
required
string
group_id
required
string

Responses

Updates an existing user invitation for the selected group.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
invitation[email]
string

Email address where the invitation should be delivered.

invitation[first_name]
string

First name of the invitation recipient.

invitation[last_name]
string

Last name of the invitation recipient.

invitation[send_immediately]
boolean

Should the invitation be delivered immediately. Defaults to false.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "invitation[email]": "string",
  • "invitation[first_name]": "string",
  • "invitation[last_name]": "string",
  • "invitation[send_immediately]": true
}

Deletes a user invitation for the selected group. Renders the invitation invalid.

path Parameters
id
required
string
group_id
required
string

Responses

Updates an existing user invitation for the selected group.

path Parameters
id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
invitation[email]
string

Email address where the invitation should be delivered.

invitation[first_name]
string

First name of the invitation recipient.

invitation[last_name]
string

Last name of the invitation recipient.

invitation[send_immediately]
boolean

Should the invitation be delivered immediately. Defaults to false.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "invitation[email]": "string",
  • "invitation[first_name]": "string",
  • "invitation[last_name]": "string",
  • "invitation[send_immediately]": true
}

Groups: Users

Returns a list of users that are part of the selected group.

path Parameters
group_id
required
string
query Parameters
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

q[text]
string

Query to search user's first or last name

q[employ_state]
string
Enum: "is_active" "is_inactive" "any"

Filter the results returned by the user's employment status with the group.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[work_title]
string

User's work title or position name.

group_licenses
Array of strings
network_licenses
Array of strings
role_ids
Array of strings

Identifiers for the roles to assign to the user.

Responses

Creates a new User, Connects it to Group and to a Groups::Role

path Parameters
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

q[text]
string

Query to search user's first or last name

q[employ_state]
string
Enum: "is_active" "is_inactive" "any"

Filter the results returned by the user's employment status with the group.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[work_title]
string

User's work title or position name.

group_licenses
Array of strings
network_licenses
Array of strings
role_ids
Array of strings

Identifiers for the roles to assign to the user.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "q[text]": "string",
  • "q[employ_state]": "is_active",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[work_title]": "string",
  • "group_licenses":
    [
    ],
  • "network_licenses":
    [
    ],
  • "role_ids":
    [
    ]
}

Returns details for a user that is part of the selected group.

path Parameters
user_id
required
string
group_id
required
string

Responses

Updates a User.

path Parameters
user_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

q[text]
string

Query to search user's first or last name

q[employ_state]
string
Enum: "is_active" "is_inactive" "any"

Filter the results returned by the user's employment status with the group.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[work_title]
string

User's work title or position name.

group_licenses
Array of strings
network_licenses
Array of strings
role_ids
Array of strings

Identifiers for the roles to assign to the user.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "q[text]": "string",
  • "q[employ_state]": "is_active",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[work_title]": "string",
  • "group_licenses":
    [
    ],
  • "network_licenses":
    [
    ],
  • "role_ids":
    [
    ]
}

Updates a User.

path Parameters
user_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

q[text]
string

Query to search user's first or last name

q[employ_state]
string
Enum: "is_active" "is_inactive" "any"

Filter the results returned by the user's employment status with the group.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[work_title]
string

User's work title or position name.

group_licenses
Array of strings
network_licenses
Array of strings
role_ids
Array of strings

Identifiers for the roles to assign to the user.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "q[text]": "string",
  • "q[employ_state]": "is_active",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[work_title]": "string",
  • "group_licenses":
    [
    ],
  • "network_licenses":
    [
    ],
  • "role_ids":
    [
    ]
}

Groups: Users - System Roles

Add a system-level role for the selected user within the selected group.

path Parameters
system_role_id
required
string
user_id
required
string
group_id
required
string

Responses

Remove a system-level role from the selected user within the selected group.

path Parameters
system_role_id
required
string
user_id
required
string
group_id
required
string

Responses

Groups: Users With Contacts

Returns a list of users and a count of their contacts with open cases or referrals

path Parameters
group_id
required
string

Responses

Groups::Contacts::Cases: Filter Timeline Events

Returns a list of filtered events.

Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
q[filter_names]
string
Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team"

Name of filter to be appliied

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[filter_names]": "client_updates",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string"
}

Groups::Contacts::Cases: Timeline Events

Returns a list of events for the selected Contact.

Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Groups::Contacts::Households::Members

Returns a list of household members for the select contact

path Parameters
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Creates a new household member for a contact. If the new member is not marked as the head_of_household, the parent contact will become the head_of_household

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
household_member[last_name]
required
string

Household Member's last name.

household_member[first_name]
required
string

Household Member's first name.

household_member[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Household Member's specified gender.

household_member[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Household Member's title.

household_member[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Household Member's suffix.

household_member[relation_to_primary]
string
Enum: "self" "child" "spouse" "parent" "partner" "other-relation" "non-relation"

Household Member's relationship to the Contact

household_member[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

household_member[head_of_household]
boolean

Is the household member the head of the household?

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "household_member[last_name]": "string",
  • "household_member[first_name]": "string",
  • "household_member[gender]": "male",
  • "household_member[title]": "Mr.",
  • "household_member[suffix]": "Jr.",
  • "household_member[relation_to_primary]": "self",
  • "household_member[date_of_birth]": 0,
  • "household_member[head_of_household]": true
}

Update a household member.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
household_member[first_name]
string

Household Member's first name.

household_member[last_name]
string

Household Member's last name.

household_member[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Household Member's specified gender.

household_member[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Household Member's title.

household_member[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Household Member's suffix.

household_member[relation_to_primary]
string
Enum: "self" "child" "spouse" "parent" "partner" "other-relation" "non-relation"

Household Member's relationship to the Contact

household_member[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

household_member[head_of_household]
boolean

Is the household member the head of the household?

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "household_member[first_name]": "string",
  • "household_member[last_name]": "string",
  • "household_member[gender]": "male",
  • "household_member[title]": "Mr.",
  • "household_member[suffix]": "Jr.",
  • "household_member[relation_to_primary]": "self",
  • "household_member[date_of_birth]": 0,
  • "household_member[head_of_household]": true
}

Destroy a household member

path Parameters
id
required
string
contact_id
required
string
group_id
required
string

Responses

Update a household member.

path Parameters
id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
household_member[first_name]
string

Household Member's first name.

household_member[last_name]
string

Household Member's last name.

household_member[gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Household Member's specified gender.

household_member[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Household Member's title.

household_member[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Household Member's suffix.

household_member[relation_to_primary]
string
Enum: "self" "child" "spouse" "parent" "partner" "other-relation" "non-relation"

Household Member's relationship to the Contact

household_member[date_of_birth]
number

Unix (epoch) timestamp representing the contact's date of birth.

household_member[head_of_household]
boolean

Is the household member the head of the household?

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "household_member[first_name]": "string",
  • "household_member[last_name]": "string",
  • "household_member[gender]": "male",
  • "household_member[title]": "Mr.",
  • "household_member[suffix]": "Jr.",
  • "household_member[relation_to_primary]": "self",
  • "household_member[date_of_birth]": 0,
  • "household_member[head_of_household]": true
}

Groups::Contacts::Households::MembersCounts

Get the household count

path Parameters
contact_id
required
string
group_id
required
string

Responses

Update a household count

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
total
number

Total number of members in the Household

children
number

Number of children in the Household

adults
number

Number of adults in the Household

should_enable
boolean

Should the static_count be enabled?

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "total": 0,
  • "children": 0,
  • "adults": 0,
  • "should_enable": true
}

Update a household count

path Parameters
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
total
number

Total number of members in the Household

children
number

Number of children in the Household

adults
number

Number of adults in the Household

should_enable
boolean

Should the static_count be enabled?

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "total": 0,
  • "children": 0,
  • "adults": 0,
  • "should_enable": true
}

Groups::Contacts::Households::MembersCounts::Disable

Sets Household count to come dynamically from the number of related Members

path Parameters
contact_id
required
string
group_id
required
string

Responses

Sets Household count to come dynamically from the number of related Members

path Parameters
contact_id
required
string
group_id
required
string

Responses

Sets Household count to come dynamically from the number of related Members

path Parameters
contact_id
required
string
group_id
required
string

Responses

Sets Household count to come dynamically from the number of related Members

path Parameters
contact_id
required
string
group_id
required
string

Responses

Groups::Contacts::Households::MembersCounts::Enable

Sets Household Count to come from static Households::MembersCount node

path Parameters
contact_id
required
string
group_id
required
string

Responses

Sets Household Count to come from static Households::MembersCount node

path Parameters
contact_id
required
string
group_id
required
string

Responses

Sets Household Count to come from static Households::MembersCount node

path Parameters
contact_id
required
string
group_id
required
string

Responses

Sets Household Count to come from static Households::MembersCount node

path Parameters
contact_id
required
string
group_id
required
string

Responses

Groups::Referrals: Hold

Places the Referral into a status of IN_REVIEW

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral_hold[reason]
string

A reason for the referral being put in review.

referral_hold[note]
string

A note concerning the referral being put in review.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral_hold[reason]": "string",
  • "referral_hold[note]": "string"
}

Places the Referral into a status of IN_REVIEW

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral_hold[reason]
string

A reason for the referral being put in review.

referral_hold[note]
string

A note concerning the referral being put in review.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral_hold[reason]": "string",
  • "referral_hold[note]": "string"
}

Groups::Referrals: Reassign Program

Reassigns the referral to another program within the recipient group

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral[referred_to_program_id]
string

ID of the Program to which the referral should be assigned

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral[referred_to_program_id]": "string"
}

Reassigns the referral to another program within the recipient group

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral[referred_to_program_id]
string

ID of the Program to which the referral should be assigned

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral[referred_to_program_id]": "string"
}

Groups::Referrals: Recall

Places the Referral into a status of RECALLED

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral_recall[reason]
string

A reason for the referral being recalled

referral_recall[note]
string

A note concerning the referral being recalled

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral_recall[reason]": "string",
  • "referral_recall[note]": "string"
}

Places the Referral into a status of RECALLED

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
referral_recall[reason]
string

A reason for the referral being recalled

referral_recall[note]
string

A note concerning the referral being recalled

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "referral_recall[reason]": "string",
  • "referral_recall[note]": "string"
}

Groups::Users: Connections

Add a user to the selected group.

path Parameters
user_id
required
string
group_id
required
string

Responses

Remove the selected user from the selected group.

path Parameters
user_id
required
string
group_id
required
string

Responses

Ingestions

Add new draft data to the ingestions queue.

path Parameters
source
required
string

Responses

Intake: Documents

Displays a list of all the documents attached.

path Parameters
intake_id
required
string
contact_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Displays a single document.

path Parameters
id
required
string
intake_id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
intake_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Deletes an attached document.

path Parameters
id
required
string
intake_id
required
string
contact_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
intake_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Invitations: User

Returns details for a user using the confirmation/invite token.

path Parameters
token
required
string

Responses

Confirms and updates the user's account.

path Parameters
token
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[work_title]
string

User's work title or position name.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[work_title]": "string"
}

Confirms and updates the user's account.

path Parameters
token
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[work_title]
string

User's work title or position name.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[work_title]": "string"
}

Network Client Military Affiliation by Gender

Returns a snapshot of Network Client Military Affiliation by Gender

path Parameters
network_id
required
string

Responses

Network Client Military Branch of Service by Gender

Returns a snapshot of Network Client Military Branch of Service by Gender

path Parameters
network_id
required
string

Responses

Network Client Military Service Era by Branch of Service

Returns a snapshot of Network Client Military Service Era by Branch of Service

path Parameters
network_id
required
string

Responses

Network Client Military Service Era by Gender

Returns a snapshot of Network Client Military Service Era by Gender

path Parameters
network_id
required
string

Responses

Network Client Military Transition Status by Branch of Service

Returns a snapshot of Network Client Military Transition Status by Branch of Service

path Parameters
network_id
required
string

Responses

Network Client Military Transitioning by Gender

Returns a snapshot of Network Client Military Transitioning by Gender

path Parameters
network_id
required
string

Responses

Network Clients Military Status by Gender

Returns a snapshot of Network Clients Military Status by Gender

path Parameters
network_id
required
string

Responses

Network Clients by Military Affiliation

Returns a snapshot of Network Clients by Military Affiliation

path Parameters
network_id
required
string

Responses

Network Clients by Military Branch of Service

Returns a snapshot of Network Clients by Military Branch of Service

path Parameters
network_id
required
string

Responses

Network Clients by Military Deployment

Returns a snapshot of Network Clients by Military Deployment

path Parameters
network_id
required
string

Responses

Network Clients by Military Discharge

Returns a snapshot of Network Clients by Military Discharge

path Parameters
network_id
required
string

Responses

Network Clients by Military Service Era

Returns a snapshot of Network Clients by Military Service Era

path Parameters
network_id
required
string

Responses

Network Clients by Military Status

Returns a snapshot of Network Clients by Military Status

path Parameters
network_id
required
string

Responses

Network Clients by Military Transitioning Status

Returns a snapshot of Network Clients by Military Transitioning Status

path Parameters
network_id
required
string

Responses

Network Contacts By Age Report

Returns a snapshot of network contacts by age

path Parameters
network_id
required
string

Responses

Network Contacts By Ethnicity Report

Returns a snapshot of network contacts by ethnicity

path Parameters
network_id
required
string

Responses

Network Contacts By Gender Report

Returns a snapshot of network contacts by gender

path Parameters
network_id
required
string

Responses

Network Contacts By Race Report

Returns a snapshot of network contacts by race

path Parameters
network_id
required
string

Responses

Networks Service Types: Outcomes

Returns all outcomes provided by the specified network service_type.

path Parameters
service_type_id
required
string
network_id
required
string

Responses

Networks: Groups

Returns a list of groups that are participating in the selected Network.

path Parameters
network_id
required
string
query Parameters
q[coordinates][lon]
required
number

Longitude Coordinate

q[coordinates][lat]
required
number

Latitude Coordinate

q[text]
required
string

Text to search the index for.

q[service_type_ids]
Array of strings

An array of service type IDs to filter on

q[distance]
string

Either a distance w/ unit OR no distance IOT fetch any distance

q[delivery_options]
Array of strings

An array of Program Delivery Method names to filter on

q[languages]
Array of strings

An array of Program Lanugage names to filter on

q[accessibility_options]
Array of strings

An array of Program Accessibility Option names to filter on

q[payment_options]
Array of strings

An array of Program Fee payment options to filter on

q[transportation_options]
Array of strings

An array of Program Transportation Option names to filter on

q[caters_to]
Array of strings

An array of Program Catered To Population names to filter on

q[restricted_to]
Array of strings

An array of Program Restricted To Population names to filter on

q[include_unlicensed_providers]
boolean

Optionally include unlicensed providers

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns details about the selected Network group.

path Parameters
id
required
string
network_id
required
string

Responses

Returns a list of groups that are participating in the selected Network.

path Parameters
network_id
required
string
query Parameters
q[service_type_ids]
Array of strings

An array of service type IDs to match network groups with.

q[name]
string

All or part of an organization name within the network to match.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Returns details about a group participating in the selected Network.

path Parameters
id
required
string
network_id
required
string

Responses

Networks: Groups by Referral Scope

Returns a list of groups based on the referral scopes existing for [Network, scope_to_group_id].

path Parameters
group_id
required
string
network_id
required
string
query Parameters
q[include_home_groups]
boolean

Optionally include all groups for any provided permitted_network which is the same as network_id, regardless of its referral scope

q[permitted_networks]
Array of strings

Identifiers of networks that should be used to determine a referral scope.

q[service_type_ids]
Array of strings

An array of service type IDs to match network groups with.

q[name]
string

All or part of an organization name within the network to match.

q[include_address_book]
boolean

Optionally include address book groups with in network groups for the current group

q[only_address_book]
boolean

Optionally only show address book groups for the current group

q[address_book_status]
string
Enum: "draft" "in_review" "published" "archived"

Optionally filter address book groups by their status

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Networks: Service Types

Returns a list of service types that the network supports

path Parameters
network_id
required
string

Responses

Networks: Service Types Offered

Returns all service types provided by the specified network.

path Parameters
network_id
required
string

Responses

Networks: Service Types Offered along with Outcomes scope to the Network

Returns all service types with outcomes provided by the specified network.

path Parameters
network_id
required
string

Responses

Returns a specific service type with outcomes provided by the specified network.

path Parameters
service_type_id
required
string
network_id
required
string

Responses

Networks: Users/Collaborators by Referral Scopes

Returns a list of users that are participating in the selected Network or referral scope networks.

path Parameters
network_id
required
string
query Parameters
q[group_id]
required
string

Identifier for the origin group used to find referral scopes (with network in scope as origin network)

q[text]
string

All or part of a user's name or email within the network to match.

q[permitted_networks]
Array of strings

Identifiers of networks that should be used to filter referral scopes.

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Notification Preferences for a Group that a User belongs to

Returns group notification settings for the current user and a group

path Parameters
id
required
string
query Parameters
group_information_updated
boolean

Group information has been updated

new_program_added
boolean

New program has been added

group_admin_added
boolean

User has been granted administrator role

group_user_changes
boolean

Changes to users - added to org, removed from org, role changed

watch_my_contacts
boolean

Updates and changes to contacts created by user

invitation_expired_for_user
boolean

Invitation expired for user

group_user_activated_their_account
boolean

User activated their account

no_remaining_organization_licences
boolean

Organization does not have any remaining licenses

new_assistance_request
boolean

New assistance request

Responses

Returns group notification settings for the current user and a group

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
group_information_updated
boolean

Group information has been updated

new_program_added
boolean

New program has been added

group_admin_added
boolean

User has been granted administrator role

group_user_changes
boolean

Changes to users - added to org, removed from org, role changed

watch_my_contacts
boolean

Updates and changes to contacts created by user

invitation_expired_for_user
boolean

Invitation expired for user

group_user_activated_their_account
boolean

User activated their account

no_remaining_organization_licences
boolean

Organization does not have any remaining licenses

new_assistance_request
boolean

New assistance request

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "group_information_updated": true,
  • "new_program_added": true,
  • "group_admin_added": true,
  • "group_user_changes": true,
  • "watch_my_contacts": true,
  • "invitation_expired_for_user": true,
  • "group_user_activated_their_account": true,
  • "no_remaining_organization_licences": true,
  • "new_assistance_request": true
}

Returns group notification settings for the current user and a group

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
group_information_updated
boolean

Group information has been updated

new_program_added
boolean

New program has been added

group_admin_added
boolean

User has been granted administrator role

group_user_changes
boolean

Changes to users - added to org, removed from org, role changed

watch_my_contacts
boolean

Updates and changes to contacts created by user

invitation_expired_for_user
boolean

Invitation expired for user

group_user_activated_their_account
boolean

User activated their account

no_remaining_organization_licences
boolean

Organization does not have any remaining licenses

new_assistance_request
boolean

New assistance request

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "group_information_updated": true,
  • "new_program_added": true,
  • "group_admin_added": true,
  • "group_user_changes": true,
  • "watch_my_contacts": true,
  • "invitation_expired_for_user": true,
  • "group_user_activated_their_account": true,
  • "no_remaining_organization_licences": true,
  • "new_assistance_request": true
}

Notification Preferences for a Network that a User belongs to

Returns network notification settings for the current user and a network

path Parameters
id
required
string
query Parameters
network_information_updated
boolean

Network information has been updated

new_program_added
boolean

New program has been added

network_admin_added
boolean

User has been granted administrator role

network_user_changes
boolean

Changes to users - added to org, removed from org, role changed

watch_my_contacts
boolean

Updates and changes to contacts created by user

Responses

Returns network notification settings for the current user and a network

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
network_information_updated
boolean

Network information has been updated

new_program_added
boolean

New program has been added

network_admin_added
boolean

User has been granted administrator role

network_user_changes
boolean

Changes to users - added to org, removed from org, role changed

watch_my_contacts
boolean

Updates and changes to contacts created by user

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "network_information_updated": true,
  • "new_program_added": true,
  • "network_admin_added": true,
  • "network_user_changes": true,
  • "watch_my_contacts": true
}

Returns network notification settings for the current user and a network

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
network_information_updated
boolean

Network information has been updated

new_program_added
boolean

New program has been added

network_admin_added
boolean

User has been granted administrator role

network_user_changes
boolean

Changes to users - added to org, removed from org, role changed

watch_my_contacts
boolean

Updates and changes to contacts created by user

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "network_information_updated": true,
  • "new_program_added": true,
  • "network_admin_added": true,
  • "network_user_changes": true,
  • "watch_my_contacts": true
}

Notifications: Email Unsubscribe

Attempt to unsubscribe an email from notifications

query Parameters
email_digest
required
string

HMAC digest (sha-256) of notification unsubscribe private key with email wishing to unsubscribe

email
required
string

Email wishing to unsubscribe

Responses

Organization Service Cases

Returns a snapshot of Organization Service Cases

path Parameters
group_id
required
string

Responses

Public: area to accept/reject consents that are created via SMS or Email

Received Referrals by Organization

Returns a snapshot of Received Referrals by Organizations

path Parameters
network_id
required
string

Responses

Referral: Forms Available for Use

Retrieve a complete group profile.

path Parameters
referral_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Referrals: Documents

Displays a list of all the documents attached.

path Parameters
referral_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Displays a single document.

path Parameters
id
required
string
referral_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Deletes an attached document.

path Parameters
id
required
string
referral_id
required
string
group_id
required
string

Responses

Updates a document.

path Parameters
id
required
string
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
document[title]
required
string

The name associated with the document

attach_to_id
string

The ID of the object to change the document attachment to.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "document[title]": "string",
  • "attach_to_id": "string"
}

Referrals: Filter Timeline Events

Returns a list of filtered events.

Filtered activity stream or timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
q[filter_names]
string
Enum: "client_updates" "closed_records" "notes" "record_updates" "network_updates" "care_team"

Name of filter to be appliied

page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "q[filter_names]": "client_updates",
  • "page": 0,
  • "per": 0,
  • "sord": "asc",
  • "sidx": "string"
}

Referrals: Primary Referral Worker

Update the primary referral worker for the selected referral.

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user_id
required
string

The ID of the user to be set as the primary referral worker.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user_id": "string"
}

Update the primary referral worker for the selected referral.

path Parameters
referral_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user_id
required
string

The ID of the user to be set as the primary referral worker.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user_id": "string"
}

Referrals: Timeline Events

Returns a list of events for the selected Contact.

Activity Stream or Timeline events are returned loosely based on the Activity Stream specification (activitystrea.ms).

Available verb values include: accept, add, assign, close, complete, create, delete, deny, join, leave, open, post, replace, retract, save, send, and update.

Use the verb, object, and target values to determine the event that occurred.

path Parameters
referral_id
required
string
group_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Screenings: Fetch screenings for contact

Displays an index of screenings

path Parameters
contact_id
required
string
group_id
required
string

Responses

Screenings: Respond to Screening

Displays an index of screenings

path Parameters
form_id
required
string
contact_id
required
string
group_id
required
string

Responses

Creates a new screening

path Parameters
form_id
required
string
contact_id
required
string
group_id
required
string

Responses

Upserts a contact's response to the specified screening

path Parameters
id
required
string
form_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Upserts a contact's response to the specified screening

path Parameters
id
required
string
form_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
data
Array of strings

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "data":
    [
    ]
}

Search

Sent Referrals by Organization

Returns a snapshot of Sent Referrals by Organizations

path Parameters
network_id
required
string

Responses

Service Cases by Service Type

Returns a snapshot of Service Cases by Service Type

path Parameters
group_id
required
string

Responses

Service Cases by Source

Returns a snapshot of Service Cases by Source

path Parameters
group_id
required
string

Responses

Service Cases by Status

Returns a snapshot of Service Cases by Status

path Parameters
group_id
required
string

Responses

Service Cases by Sub Types of Service Type

Returns a snapshot of Service Cases by Sub Types of Service Type

path Parameters
service_type_id
required
string
group_id
required
string

Responses

Unique Network Contacts Report

Returns a snapshot of total unique network contacts

path Parameters
network_id
required
string

Responses

Unique Network Organizations Report

Returns a snapshot of total unique network groups

path Parameters
network_id
required
string

Responses

Unique Network Users Report

Returns a snapshot of total unique network Users

path Parameters
network_id
required
string

Responses

Unique Organization Clients Report

Returns a snapshot of total unique group clients

path Parameters
group_id
required
string

Responses

User Confirmation

Confirm a user account.

Confirms a user account using the provided confirmation token. A successfully confirmed account will result in a 200 OK response.

query Parameters
confirmation_token
required
string

Confirmation token delivered to the email address of user.

Responses

User Registration

Registers a new user account for the Unite US application. The user may be required to confirm her email address.

Request Body schema:
application/json
application/json
multipart/form-data
user[last_name]
required
string

User's last name.

user[first_name]
required
string

User's first name.

user[password_confirmation]
required
string

Confirmation of the user's password.

user[password]
required
string

User's preferred password.

user[email]
required
string

User's email address.

user[title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

User's title.

user[middle_name_initial]
string

User's middle name or initial.

user[suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

User's suffix.

invitation[token]
string

The invitation token used to connect the new user to other resources.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[last_name]": "string",
  • "user[first_name]": "string",
  • "user[password_confirmation]": "string",
  • "user[password]": "string",
  • "user[email]": "string",
  • "user[title]": "Mr.",
  • "user[middle_name_initial]": "string",
  • "user[suffix]": "Jr.",
  • "invitation[token]": "string"
}

Users

Retrieve a complete user profile.

path Parameters
id
required
string

Responses

Updates the user's account.

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[title]
string

User's work title or position name.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[title]": "string"
}

Updates the user's account.

path Parameters
id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
user[profile][gender]
required
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

User's specified gender.

user[email]
string

User's email address.

user[first_name]
string

User's first name.

user[last_name]
string

User's last name.

user[password]
string

User's preferred password, only if changing it.

user[password_confirmation]
string

Confirmation of user's preferred password, only if changing it.

user[profile][description]
string

User's profile description or bio text.

user[title]
string

User's work title or position name.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "user[profile][gender]": "male",
  • "user[email]": "string",
  • "user[first_name]": "string",
  • "user[last_name]": "string",
  • "user[password]": "string",
  • "user[password_confirmation]": "string",
  • "user[profile][description]": "string",
  • "user[title]": "string"
}

Users: Active Session Management

Manage active user sessions (tokens) registered with the API.

Returns a list of active API Access Tokens for the current user.

path Parameters
user_id
required
string

Responses

Invalidates the selected token, thus destroying that session.

Should be used to selectively invalidate active API tokens for the current user. If successful, a 204 NO CONTENT response will be returned.

path Parameters
user_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
token
string

The token to destroy.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "token": "string"
}

Users: Addresses

Returns a list of addresses attached to the user's account.

path Parameters
user_id
required
string
query Parameters
page
number

The page of results to be returned.

per
number

The number of records to be returned per page.

sord
string
Enum: "asc" "desc"

The order to sort the results.

sidx
string

The attribute to sort the results by.

Responses

Users: License Agreements (EULA)

Accepts license agreement for a user to access the software. UU3-1307

Accept license to use software.

Accepts the license agreement for the user. A successful registration will return a 201 CREATED response to the client.

path Parameters
user_id
required
string

Responses

Users: Two-Factor Authentication (2FA)

Enable and disable 2FA for a Unite US user account.

Enable a user account to use two-factor authentication (2FA).

Registers the user with the two-factor authentication service to enable 2FA on the account. A successful registration will return a 201 CREATED response to the client.

path Parameters
user_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
phone_number[phone_number]
required
string

The user's mobile phone number. It must be SMS-capable.

phone_number[country_code]
number

The user's country code. Defaults to 1, for United States.

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "phone_number[phone_number]": "string",
  • "phone_number[country_code]": 0
}

Disable two-factor authentication (2FA) for the user's account.

De-registers the user's account with the two-factor authentication service and removes the 2FA setting for their Unite US account. Successful de-registration will return a 204 NO CONTENT response.

path Parameters
user_id
required
string

Responses

Users: Zendesk Support

Retrieve a user's Zendesk login URL.

Responses

Widgets: Assistance Requests

Retrieve the assistance request form configuration for the group specified by the provided access token.

Responses

Submit a new assistance request.

Request Body schema:
application/json
application/json
multipart/form-data
assistance_request[requestor][phone_number][phone_number]
required
string

The phone number itself. Minimum 7 digits, only numbers will be stored.

assistance_request[requestor][address][country]
required
string

Country for the address.

assistance_request[requestor][address][state]
required
string

State or province for the address.

assistance_request[requestor][address][postal_code]
required
string

Postal or ZIP code for the address. Minimum 5 characters in length, maximum 15.

assistance_request[requestor][address][city]
required
string

City or town of the address.

assistance_request[requestor][address][line_1]
required
string

Address line 1

assistance_request[requestor][address][address_type]
required
string
Enum: "home" "mailing" "work" "unknown"

Type of address.

assistance_request[requestor][email_address][email_address]
required
string

A valid email address

assistance_request[requestor][last_name]
required
string

Requestor's last name.

assistance_request[requestor][first_name]
required
string

Requestor's first name.

assistance_request[service_type_id]
required
string

Identifier of the type of service requested.

assistance_request[description]
required
string

Full-text of the assistance request.

assistance_request[requestor][email]
string

Requestor's email address.

assistance_request[requestor][date_of_birth]
number

Unix (epoch) timestamp representing the requestor's date of birth.

assistance_request[requestor][gender]
string
Enum: "male" "female" "undisclosed" "non-binary" "other"

Requestor's specified gender.

assistance_request[requestor][citizenship]
string
Enum: "us-citizen" "us-national" "lawful-permanent-resident" "other" "undisclosed"

Requestor's specified citizenship.

assistance_request[requestor][ethnicity]
string
Enum: "hispanic-or-latino" "not-hispanic-or-latino" "undisclosed"

Requestor's specified ethnicity.

assistance_request[requestor][marital_status]
string
Enum: "divorced" "domestic_partner" "married-civil-union" "single/never-married" "separated" "undisclosed" "widowed"

Requestor's specified marital status.

assistance_request[requestor][race]
string
Enum: "american-indian-alaska-native" "asian" "black-african-american" "native-hawaiian-or-pacific-islander" "other-race" "undisclosed" "white"

Requestor's specified race.

assistance_request[requestor][email_address][is_primary]
boolean

Is this email address the primary one for the requestor.

assistance_request[requestor][preferred_first_name]
string

Requestor's preferred first name.

assistance_request[requestor][title]
string
Enum: "Mr." "Miss" "Mrs." "Ms." "Dr."

Requestor's title.

assistance_request[requestor][middle_name_initial]
string

Requestor's middle name or initial.

assistance_request[requestor][suffix]
string
Enum: "Jr." "Sr." "III" "IV" "V" "Esq." "Ph.D"

Requestor's suffix.

assistance_request[requestor][address][line_2]
string

Additional address details, ex. apartment, suite, etc.

assistance_request[requestor][address][is_mailing_address]
boolean

Is this a mailing address.

assistance_request[requestor][phone_number][is_primary]
boolean

Is this phone number the requestor's primary requestor number.

assistance_request[requestor][phone_number][phone_type]
string
Enum: "mobile" "home" "work" "fax" "unknown"

Type of phone number.

assistance_request[requestor][phone_number][can_sms]
boolean

Can this phone number receive SMS?

assistance_request[requestor][phone_number][country_code]
string

Country code for the phone number. Defaults to 1, if not specified.

assistance_request[requestor][military][affiliation]
string
Enum: "military_member_or_veteran" "spouse" "widow" "family_member" "caregiver" "prefer_not_to_disclose"

Military affiliation

assistance_request[requestor][military][current_status]
string
Enum: "active_duty" "national_guard" "reserve" "retiree" "veteran" "prefer_not_to_disclose"

Current military status

assistance_request[requestor][military][currently_transitioning]
string
Enum: "yes_12mos_before" "yes_12mos_after" "no" "prefer_not_to_disclose"

Is the requestor currently transitioning?

assistance_request[requestor][military][at_least_one_day_active_duty]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has at least one day of active duty outside of basic training?

assistance_request[requestor][military][branch]
string
Enum: "air_force" "army" "coast_guard" "marines" "navy" "prefer_not_to_disclose"

Branch of service

assistance_request[requestor][military][service_era]
string
Enum: "post_911" "persian_gulf" "post_vietnam" "vietnam" "post_korean" "korean_war" "pre_korean" "ww2" "merchant_marine" "ww1" "prefer_not_to_disclose"

Service era

assistance_request[requestor][military][entry_date]
number

Date of entry

assistance_request[requestor][military][exit_date]
number

Date of exit

assistance_request[requestor][military][deployed]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Deployed?

assistance_request[requestor][military][deployment_starts_at]
number

Deployment start date

assistance_request[requestor][military][deployment_ends_at]
number

Deployment end date

assistance_request[requestor][military][discharge_type]
string
Enum: "honorable" "general" "other_than_honorable" "bad_conduct" "dishonorable" "uncharacterized" "other" "prefer_not_to_disclose"

Discharge type

assistance_request[requestor][military][discharged_due_to_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Discharged or retired from military service for a disability incurred in the line of duty?

assistance_request[requestor][military][service_connected_disability]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Has VA-rated Service-Connected Disability?

assistance_request[requestor][military][service_connected_disability_rating]
string
Enum: "0" "10" "20" "30" "40" "50" "60" "70" "80" "90" "100" "prefer_not_to_disclose"

Service-Connected Disability Rating

assistance_request[requestor][military][proof_of_veteran_status]
string
Enum: "yes" "no" "prefer_not_to_disclose"

Have proof of veteran status?

assistance_request[requestor][military][proof_type]
string
Enum: "dd214" "va_id" "statement_of_service" "retiree_id" "drivers_license" "military_id" "other" "prefer_not_to_disclose"

Proof type

assistance_request[requestor][form_response][form_id]
string

The identifier of the assistance request form.

assistance_request[requestor][form_response][data]
Array of strings
assistance_request[consent][signature_image]
string

Base64 of the signature image

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "assistance_request[requestor][phone_number][phone_number]": "string",
  • "assistance_request[requestor][address][country]": "string",
  • "assistance_request[requestor][address][state]": "string",
  • "assistance_request[requestor][address][postal_code]": "string",
  • "assistance_request[requestor][address][city]": "string",
  • "assistance_request[requestor][address][line_1]": "string",
  • "assistance_request[requestor][address][address_type]": "home",
  • "assistance_request[requestor][email_address][email_address]": "string",
  • "assistance_request[requestor][last_name]": "string",
  • "assistance_request[requestor][first_name]": "string",
  • "assistance_request[service_type_id]": "string",
  • "assistance_request[description]": "string",
  • "assistance_request[requestor][email]": "string",
  • "assistance_request[requestor][date_of_birth]": 0,
  • "assistance_request[requestor][gender]": "male",
  • "assistance_request[requestor][citizenship]": "us-citizen",
  • "assistance_request[requestor][ethnicity]": "hispanic-or-latino",
  • "assistance_request[requestor][marital_status]": "divorced",
  • "assistance_request[requestor][race]": "american-indian-alaska-native",
  • "assistance_request[requestor][email_address][is_primary]": true,
  • "assistance_request[requestor][preferred_first_name]": "string",
  • "assistance_request[requestor][title]": "Mr.",
  • "assistance_request[requestor][middle_name_initial]": "string",
  • "assistance_request[requestor][suffix]": "Jr.",
  • "assistance_request[requestor][address][line_2]": "string",
  • "assistance_request[requestor][address][is_mailing_address]": true,
  • "assistance_request[requestor][phone_number][is_primary]": true,
  • "assistance_request[requestor][phone_number][phone_type]": "mobile",
  • "assistance_request[requestor][phone_number][can_sms]": true,
  • "assistance_request[requestor][phone_number][country_code]": "string",
  • "assistance_request[requestor][military][affiliation]": "military_member_or_veteran",
  • "assistance_request[requestor][military][current_status]": "active_duty",
  • "assistance_request[requestor][military][currently_transitioning]": "yes_12mos_before",
  • "assistance_request[requestor][military][at_least_one_day_active_duty]": "yes",
  • "assistance_request[requestor][military][branch]": "air_force",
  • "assistance_request[requestor][military][service_era]": "post_911",
  • "assistance_request[requestor][military][entry_date]": 0,
  • "assistance_request[requestor][military][exit_date]": 0,
  • "assistance_request[requestor][military][deployed]": "yes",
  • "assistance_request[requestor][military][deployment_starts_at]": 0,
  • "assistance_request[requestor][military][deployment_ends_at]": 0,
  • "assistance_request[requestor][military][discharge_type]": "honorable",
  • "assistance_request[requestor][military][discharged_due_to_disability]": "yes",
  • "assistance_request[requestor][military][service_connected_disability]": "yes",
  • "assistance_request[requestor][military][service_connected_disability_rating]": "0",
  • "assistance_request[requestor][military][proof_of_veteran_status]": "yes",
  • "assistance_request[requestor][military][proof_type]": "dd214",
  • "assistance_request[requestor][form_response][form_id]": "string",
  • "assistance_request[requestor][form_response][data]":
    [
    ],
  • "assistance_request[consent][signature_image]": "string"
}

Apiv3groupsassistance requestsclosings

Set the selected case to closed and create a closing node

path Parameters
assistance_request_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
exited_at
required
string

The date the assistance request was closed

outcome_id
required
string

The id of the outcome this closing is associated with

resolved
required
string
Enum: "true" "false"

The status of the case

note
string

A note pertaining to the closing

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "exited_at": "string",
  • "outcome_id": "string",
  • "resolved": "true",
  • "note": "string"
}

Set the selected case to closed and create a closing node

path Parameters
assistance_request_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
exited_at
required
string

The date the assistance request was closed

outcome_id
required
string

The id of the outcome this closing is associated with

resolved
required
string
Enum: "true" "false"

The status of the case

note
string

A note pertaining to the closing

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "exited_at": "string",
  • "outcome_id": "string",
  • "resolved": "true",
  • "note": "string"
}

Apiv3groupscontactscasesservice casesclosings

Set the selected case to closed and create a closing node

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
outcome_id
required
string

The id of the outcome this closing is associated with

status
required
string
Enum: "resolved" "unresolved"

The status of the case; either resolved or unresolved.

note
string

A note pertaining to the closing

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "outcome_id": "string",
  • "status": "resolved",
  • "note": "string"
}

Set the selected case to closed and create a closing node

path Parameters
service_case_id
required
string
contact_id
required
string
group_id
required
string
Request Body schema:
application/json
application/json
multipart/form-data
outcome_id
required
string

The id of the outcome this closing is associated with

status
required
string
Enum: "resolved" "unresolved"

The status of the case; either resolved or unresolved.

note
string

A note pertaining to the closing

Responses

Request samples

Content type
application/json
application/json
multipart/form-data
{
  • "outcome_id": "string",
  • "status": "resolved",
  • "note": "string"
}

Apiv3securesessionssupports

Return supporting information about the user's current session

Responses